-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Stream logs using journalctl.
--   
--   Stream logs using journalctl. Check the documentation for more
--   details.
@package journalctl-stream
@version 0.6.0.2


-- | Streaming interface to journalctl. Use <a>entryStream</a> to stream
--   journalctl entries as they are created.
--   
--   Designed with qualified import in mind. For example, if you import it
--   as <tt>Journal</tt>, then <a>Entry</a> becomes <tt>Journal.Entry</tt>,
--   and <a>Exception</a> becomes <tt>Journal.Exception</tt>.
module Systemd.Journalctl.Stream

-- | A journal entry.
data Entry
Entry :: Maybe ProcessID -> Text -> Maybe Text -> Maybe Text -> Maybe FilePath -> Cursor -> POSIXTime -> Maybe Text -> Maybe (Either ByteString Text) -> Entry

-- | Process ID.
[entryPID] :: Entry -> Maybe ProcessID

-- | The name of the originating host.
[entryHostname] :: Entry -> Text

-- | Namespace identifier.
[entryNamespace] :: Entry -> Maybe Text

-- | Process name.
[entryProcess] :: Entry -> Maybe Text

-- | File path to the executable.
[entryExecutable] :: Entry -> Maybe FilePath

-- | The cursor for the entry.
[entryCursor] :: Entry -> Cursor

-- | The time the entry was received by the journal.
[entryTimestamp] :: Entry -> POSIXTime

-- | Unit name, if present.
[entryUnit] :: Entry -> Maybe Text

-- | Entry message. It may come in binary or textual format.
[entryMessage] :: Entry -> Maybe (Either ByteString Text)

-- | A cursor is an opaque text string that uniquely describes the position
--   of an entry in the journal and is portable across machines, platforms
--   and journal files.
--   
--   The <a>Ord</a> instance does not order by time. Given two entries
--   <tt>e1</tt> and <tt>e2</tt>, <tt>e1</tt> having an earlier timestamp
--   than <tt>e2</tt> doesn't mean that <tt>entryCursor e1 &lt; entryCursor
--   e2</tt>.
data Cursor

-- | Where to start a stream.
data StreamStart

-- | Start from the given time.
StartTime :: LocalTime -> StreamStart

-- | Start from the given number of lines back.
Lines :: Int -> StreamStart

-- | Start <i>at</i> the given cursor.
AtCursor :: Cursor -> StreamStart

-- | Start <i>after</i> the given cursor.
AfterCursor :: Cursor -> StreamStart

-- | Stream all journal entries starting from the given point.
entryStream :: (MonadResource m, MonadThrow m) => StreamStart -> ConduitT i Entry m ()

-- | Exception raised while streaming entries from journalctl.
data Exception
instance GHC.Show.Show Systemd.Journalctl.Stream.Cursor
instance GHC.Classes.Ord Systemd.Journalctl.Stream.Cursor
instance GHC.Classes.Eq Systemd.Journalctl.Stream.Cursor
instance GHC.Show.Show Systemd.Journalctl.Stream.Entry
instance GHC.Show.Show a => GHC.Show.Show (Systemd.Journalctl.Stream.AsText a)
instance GHC.Show.Show Systemd.Journalctl.Stream.Exception
instance GHC.Exception.Type.Exception Systemd.Journalctl.Stream.Exception
instance Data.Aeson.Types.FromJSON.FromJSON a => Data.Aeson.Types.FromJSON.FromJSON (Systemd.Journalctl.Stream.AsText a)
instance Data.Aeson.Types.FromJSON.FromJSON Systemd.Journalctl.Stream.Entry
instance Data.Aeson.Types.FromJSON.FromJSON Systemd.Journalctl.Stream.Cursor
instance Data.Aeson.Types.ToJSON.ToJSON Systemd.Journalctl.Stream.Cursor