GI.Soup.Objects.Logger

No description available in the introspection data.

Exported types

newtype Logger

Memory-managed wrapper type.

Constructors

Logger (ManagedPtr Logger)

Instances

GObject Logger

Defined in GI.Soup.Objects.Logger

Methods

gobjectType :: IO GType

HasParentTypes Logger

Defined in GI.Soup.Objects.Logger

type ParentTypes Logger

Defined in GI.Soup.Objects.Logger

type ParentTypes Logger = Object ': (SessionFeature ': ([] :: [Type]))

class (GObject o, IsDescendantOf Logger o) => IsLogger o

Type class for types which can be safely cast to Logger, for instance with toLogger.

Instances

(GObject o, IsDescendantOf Logger o) => IsLogger o

Defined in GI.Soup.Objects.Logger

toLogger :: (MonadIO m, IsLogger o) => o -> m Logger

Cast to Logger, for types for which this is known to be safe. For general casts, use castTo.

noLogger :: Maybe Logger

A convenience alias for Nothing :: Maybe Logger.

Methods

attach

loggerAttach

Arguments

:: (HasCallStack, MonadIO m, IsLogger a, IsSession b)

=> a

logger: a Logger

-> b

session: a Session

-> m ()

Deprecated: Use sessionAddFeature instead.

Sets logger to watch session and print debug information for its messages.

(The session will take a reference on logger, which will be removed when you call loggerDetach, or when the session is destroyed.)

detach

loggerDetach

Arguments

:: (HasCallStack, MonadIO m, IsLogger a, IsSession b)

=> a

logger: a Logger

-> b

session: a Session

-> m ()

Deprecated: Use sessionRemoveFeature instead.

Stops logger from watching session.

new

loggerNew

Arguments

:: (HasCallStack, MonadIO m)

=> LoggerLogLevel

level: the debug level

-> Int32

maxBodySize: the maximum body size to output, or -1

-> m Logger

Returns: a new Logger

Creates a new Logger with the given debug level. If level is LoggerLogLevelBody, maxBodySize gives the maximum number of bytes of the body that will be logged. (-1 means "no limit".)

If you need finer control over what message parts are and aren't logged, use loggerSetRequestFilter and loggerSetResponseFilter.

setPrinter

loggerSetPrinter

Arguments

:: (HasCallStack, MonadIO m, IsLogger a)

=> a

logger: a Logger

-> LoggerPrinter

printer: the callback for printing logging output

-> m ()

Sets up an alternate log printing routine, if you don't want the log to go to <literal>stdout</literal>.

setRequestFilter

loggerSetRequestFilter

Arguments

:: (HasCallStack, MonadIO m, IsLogger a)

=> a

logger: a Logger

-> LoggerFilter

requestFilter: the callback for request debugging

-> m ()

Sets up a filter to determine the log level for a given request. For each HTTP request logger will invoke requestFilter to determine how much (if any) of that request to log. (If you do not set a request filter, logger will just always log requests at the level passed to loggerNew.)

setResponseFilter

loggerSetResponseFilter

Arguments

:: (HasCallStack, MonadIO m, IsLogger a)

=> a

logger: a Logger

-> LoggerFilter

responseFilter: the callback for response debugging

-> m ()

Sets up a filter to determine the log level for a given response. For each HTTP response logger will invoke responseFilter to determine how much (if any) of that response to log. (If you do not set a response filter, logger will just always log responses at the level passed to loggerNew.)

Properties

level

The level of logging output

Since: 2.56

constructLoggerLevel :: IsLogger o => LoggerLogLevel -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “level” property. This is rarely needed directly, but it is used by new.

getLoggerLevel :: (MonadIO m, IsLogger o) => o -> m LoggerLogLevel

Get the value of the “level” property. When overloading is enabled, this is equivalent to

get logger #level

setLoggerLevel :: (MonadIO m, IsLogger o) => o -> LoggerLogLevel -> m ()

Set the value of the “level” property. When overloading is enabled, this is equivalent to

set logger [ #level := value ]

maxBodySize

If Logger:level is LoggerLogLevelBody, this gives the maximum number of bytes of the body that will be logged. (-1 means "no limit".)

Since: 2.56

constructLoggerMaxBodySize :: IsLogger o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “max-body-size” property. This is rarely needed directly, but it is used by new.

getLoggerMaxBodySize :: (MonadIO m, IsLogger o) => o -> m Int32

Get the value of the “max-body-size” property. When overloading is enabled, this is equivalent to

get logger #maxBodySize

setLoggerMaxBodySize :: (MonadIO m, IsLogger o) => o -> Int32 -> m ()

Set the value of the “max-body-size” property. When overloading is enabled, this is equivalent to

set logger [ #maxBodySize := value ]