GI.Soup.Objects.Request

A request to retrieve a particular URI.

Exported types

newtype Request

Constructors

Request (ManagedPtr Request)

Instances

GObject Request

Methods

gobjectType :: Request -> IO GType

IsInitable Request

IsObject Request

IsRequest Request

((~) * info (ResolveRequestMethod t Request), MethodInfo * info Request p) => IsLabel t (Request -> p)

Methods

fromLabel :: Proxy# Symbol t -> Request -> p

((~) * info (ResolveRequestMethod t Request), MethodInfo * info Request p) => IsLabelProxy t (Request -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Request -> p

HasAttributeList * Request

type AttributeList Request

type AttributeList Request

type SignalList Request

type SignalList Request

class GObject o => IsRequest o

Instances

(GObject a, UnknownAncestorError Constraint Request a) => IsRequest a

IsRequest RequestHTTP

IsRequest Request

IsRequest RequestData

IsRequest RequestFile

toRequest :: IsRequest o => o -> IO Request

noRequest :: Maybe Request

Methods

getContentLength

data RequestGetContentLengthMethodInfo

Instances

((~) * signature (m Int64), MonadIO m, IsRequest a) => MethodInfo * RequestGetContentLengthMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RequestGetContentLengthMethodInfo a -> signature -> s

requestGetContentLength

Arguments

:: (HasCallStack, MonadIO m, IsRequest a)

=> a

request: a Request

-> m Int64

Returns: the length of the data represented by request, or -1 if not known.

Gets the length of the data represented by request. For most request types, this will not be known until after you call requestSend or requestSendFinish.

Since: 2.42

getContentType

data RequestGetContentTypeMethodInfo

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsRequest a) => MethodInfo * RequestGetContentTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RequestGetContentTypeMethodInfo a -> signature -> s

requestGetContentType

Arguments

:: (HasCallStack, MonadIO m, IsRequest a)

=> a

request: a Request

-> m (Maybe Text)

Returns: the type of the data represented by request, or Nothing if not known.

Gets the type of the data represented by request. For most request types, this will not be known until after you call requestSend or requestSendFinish.

As in the HTTP Content-Type header, this may include parameters after the MIME type.

Since: 2.42

getSession

data RequestGetSessionMethodInfo

Instances

((~) * signature (m Session), MonadIO m, IsRequest a) => MethodInfo * RequestGetSessionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RequestGetSessionMethodInfo a -> signature -> s

requestGetSession

Arguments

:: (HasCallStack, MonadIO m, IsRequest a)

=> a

request: a Request

-> m Session

Returns: request's Session

Gets request's Session

Since: 2.42

getUri

data RequestGetUriMethodInfo

Instances

((~) * signature (m URI), MonadIO m, IsRequest a) => MethodInfo * RequestGetUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RequestGetUriMethodInfo a -> signature -> s

requestGetUri

Arguments

:: (HasCallStack, MonadIO m, IsRequest a)

=> a

request: a Request

-> m URI

Returns: request's URI

Gets request's URI

Since: 2.42

send

data RequestSendMethodInfo

Instances

((~) * signature (Maybe b -> m InputStream), MonadIO m, IsRequest a, IsCancellable b) => MethodInfo * RequestSendMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RequestSendMethodInfo a -> signature -> s

requestSend

Arguments

:: (HasCallStack, MonadIO m, IsRequest a, IsCancellable b)

=> a

request: a Request

-> Maybe b

cancellable: a Cancellable or Nothing

-> m InputStream

Returns: a InputStream that can be used to read from the URI pointed to by request. (Can throw GError)

Synchronously requests the URI pointed to by request, and returns a InputStream that can be used to read its contents.

Note that you cannot use this method with SoupRequests attached to a SessionAsync.

Since: 2.42

sendAsync

data RequestSendAsyncMethodInfo

Instances

((~) * signature (Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsRequest a, IsCancellable b) => MethodInfo * RequestSendAsyncMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RequestSendAsyncMethodInfo a -> signature -> s

requestSendAsync

Arguments

:: (HasCallStack, MonadIO m, IsRequest a, IsCancellable b)

=> a

request: a Request

-> Maybe b

cancellable: a Cancellable or Nothing

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback

-> m ()

Begins an asynchronously request for the URI pointed to by request.

Note that you cannot use this method with SoupRequests attached to a SessionSync.

Since: 2.42

sendFinish

data RequestSendFinishMethodInfo

Instances

((~) * signature (b -> m InputStream), MonadIO m, IsRequest a, IsAsyncResult b) => MethodInfo * RequestSendFinishMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RequestSendFinishMethodInfo a -> signature -> s

requestSendFinish

Arguments

:: (HasCallStack, MonadIO m, IsRequest a, IsAsyncResult b)

=> a

request: a Request

-> b

result: the AsyncResult

-> m InputStream

Returns: a InputStream that can be used to read from the URI pointed to by request. (Can throw GError)

Gets the result of a requestSendAsync.

Since: 2.42

Properties

session

data RequestSessionPropertyInfo

Instances

AttrInfo RequestSessionPropertyInfo

Associated Types

type AttrAllowedOps RequestSessionPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RequestSessionPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RequestSessionPropertyInfo :: * -> Constraint

type AttrGetType RequestSessionPropertyInfo :: *

type AttrLabel RequestSessionPropertyInfo :: Symbol

type AttrOrigin RequestSessionPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RequestSessionPropertyInfo o => Proxy * RequestSessionPropertyInfo -> o -> IO (AttrGetType RequestSessionPropertyInfo)

attrSet :: (AttrBaseTypeConstraint RequestSessionPropertyInfo o, AttrSetTypeConstraint RequestSessionPropertyInfo b) => Proxy * RequestSessionPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RequestSessionPropertyInfo o => Proxy * RequestSessionPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RequestSessionPropertyInfo o, AttrSetTypeConstraint RequestSessionPropertyInfo b) => Proxy * RequestSessionPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RequestSessionPropertyInfo

type AttrOrigin RequestSessionPropertyInfo = Request

type AttrLabel RequestSessionPropertyInfo

type AttrLabel RequestSessionPropertyInfo = "session"

type AttrGetType RequestSessionPropertyInfo

type AttrGetType RequestSessionPropertyInfo = Session

type AttrBaseTypeConstraint RequestSessionPropertyInfo

type AttrBaseTypeConstraint RequestSessionPropertyInfo = IsRequest

type AttrSetTypeConstraint RequestSessionPropertyInfo

type AttrSetTypeConstraint RequestSessionPropertyInfo = IsSession

type AttrAllowedOps RequestSessionPropertyInfo

type AttrAllowedOps RequestSessionPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructRequestSession :: (IsRequest o, IsSession a) => a -> IO (GValueConstruct o)

getRequestSession :: (MonadIO m, IsRequest o) => o -> m Session

requestSession :: AttrLabelProxy "session"

uri

data RequestUriPropertyInfo

Instances

AttrInfo RequestUriPropertyInfo

Associated Types

type AttrAllowedOps RequestUriPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RequestUriPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RequestUriPropertyInfo :: * -> Constraint

type AttrGetType RequestUriPropertyInfo :: *

type AttrLabel RequestUriPropertyInfo :: Symbol

type AttrOrigin RequestUriPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RequestUriPropertyInfo o => Proxy * RequestUriPropertyInfo -> o -> IO (AttrGetType RequestUriPropertyInfo)

attrSet :: (AttrBaseTypeConstraint RequestUriPropertyInfo o, AttrSetTypeConstraint RequestUriPropertyInfo b) => Proxy * RequestUriPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RequestUriPropertyInfo o => Proxy * RequestUriPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RequestUriPropertyInfo o, AttrSetTypeConstraint RequestUriPropertyInfo b) => Proxy * RequestUriPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RequestUriPropertyInfo

type AttrOrigin RequestUriPropertyInfo = Request

type AttrLabel RequestUriPropertyInfo

type AttrLabel RequestUriPropertyInfo = "uri"

type AttrGetType RequestUriPropertyInfo

type AttrGetType RequestUriPropertyInfo = URI

type AttrBaseTypeConstraint RequestUriPropertyInfo

type AttrBaseTypeConstraint RequestUriPropertyInfo = IsRequest

type AttrSetTypeConstraint RequestUriPropertyInfo

type AttrSetTypeConstraint RequestUriPropertyInfo = * ~ URI

type AttrAllowedOps RequestUriPropertyInfo

type AttrAllowedOps RequestUriPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructRequestUri :: IsRequest o => URI -> IO (GValueConstruct o)

getRequestUri :: (MonadIO m, IsRequest o) => o -> m URI

requestUri :: AttrLabelProxy "uri"