GI.Poppler.Objects.Attachment

No description available in the introspection data.

Exported types

newtype Attachment

Memory-managed wrapper type.

Constructors

Attachment (ManagedPtr Attachment)

Instances

GObject Attachment

Defined in GI.Poppler.Objects.Attachment

Methods

gobjectType :: IO GType

HasParentTypes Attachment

Defined in GI.Poppler.Objects.Attachment

type ParentTypes Attachment

Defined in GI.Poppler.Objects.Attachment

type ParentTypes Attachment = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf Attachment o) => IsAttachment o

Type class for types which can be safely cast to Attachment, for instance with toAttachment.

Instances

(GObject o, IsDescendantOf Attachment o) => IsAttachment o

Defined in GI.Poppler.Objects.Attachment

toAttachment :: (MonadIO m, IsAttachment o) => o -> m Attachment

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

noAttachment :: Maybe Attachment

A convenience alias for Nothing :: Maybe Attachment.

Methods

save

attachmentSave

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: A Attachment.

-> Text

filename: name of file to save

-> m ()

(Can throw GError)

Saves attachment to a file indicated by filename. If error is set, False will be returned. Possible errors include those in the G_FILE_ERROR domain and whatever the save function generates.

saveToCallback

attachmentSaveToCallback

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: A Attachment.

-> FunPtr C_AttachmentSaveFunc

saveFunc: a function that is called to save each block of data that the save routine generates.

-> m ()

(Can throw GError)

Saves attachment by feeding the produced data to saveFunc. Can be used when you want to store the attachment to something other than a file, such as an in-memory buffer or a socket. If error is set, False will be returned. Possible errors include those in the G_FILE_ERROR domain and whatever the save function generates.