Network.Xmpp.Lens

(More than just) Van Laarhoven lenses for XMPP types. The accessors in here are designed to work with an optics library like lens or lens-family. This module also provides a few simple functions (view, modify, set and getAll) so you don't need to pull in another library to get some use out of them.

• The name of the lenses corresponds to the field name of the data types with an upper-case L appended. For documentation of the fields refer to the documentation of the data types (linked in the section header)
• Same goes for Traversals, except they are suffixed with a 'T'
• Prism generally start with an underscore

NB you do not need to import this module to get access to the optics defined herein. They are also exported from Network.Xmpp. You only need to import this module if you want to use the complementary accessor functions without using an optics library like lens or lens-family

Documentation

type Lens a b = forall f. Functor f => (b -> f b) -> a -> f a

Deprecated: Use Lens' from lens-family or lens

Van-Laarhoven lenses.

type Traversal a b = forall f. Applicative f => (b -> f b) -> a -> f a

Deprecated: Use Traversal' from lens-family or lens

type Prism a b = forall p f. (Choice p, Applicative f) => p b (f b) -> p a (f a)

type Iso a b = forall p f. (Profunctor p, Functor f) => p b (f b) -> p a (f a)

Accessors

Reimplementation of the basic lens functions so you don't have to bring in a lens library to use the optics

Lenses

view :: FoldLike b a a' b b' -> a -> b

view :: Getter a a' b b' -> a -> b

Demote a lens or getter to a projection function.

view :: Monoid b => Fold a a' b b' -> a -> b

Returns the monoidal summary of a traversal or a fold.

modify :: Traversal a b -> (b -> b) -> a -> a

Deprecated: use over (lens-family, lens)

set :: Setter a a' b b' -> b' -> a -> a'

Set all referenced fields to the given value.

Traversals

getAll :: Traversal a b -> a -> [b]

Deprecated: use toListOf (lens-family), partsOf (lens) or similar

Return all the values a Traversal is pointing to in a list

Prisms

Construction

prism' :: (b -> s) -> (s -> Maybe b) -> Prism s b

mkLens :: (a -> b) -> (b -> a -> a) -> Lens a b

mkIso :: (a -> b) -> (b -> a) -> Iso a b

Lenses

JID

_JidText :: Prism Text Jid

_isFull :: Prism Jid Jid

_isBare :: Prism Jid Jid

Stanzas and Nonzas

_Stanza :: Prism XmppElement Stanza

_Nonza :: Prism XmppElement Element

_IQRequest :: Prism Stanza IQRequest

_IQResult :: Prism Stanza IQResult

_IQError :: Prism Stanza IQError

_Message :: Prism Stanza Message

_MessageError :: Prism Stanza MessageError

_Presence :: Prism Stanza Presence

_PresenceError :: Prism Stanza PresenceError

class IsStanza s where

Minimal complete definition

from, to, lang, sid, payloadT

Methods

from :: Lens s (Maybe Jid)

From-attribute of the stanza

to :: Lens s (Maybe Jid)

To-attribute of the stanza

lang :: Lens s (Maybe LangTag)

Langtag of the stanza

sid :: Lens s (Maybe Text)

Stanza ID. Setting this to Nothing for IQ* stanzas will set the id to the empty Text.

payloadT :: Traversal s Element

Traversal over the payload elements.

Instances

IsStanza PresenceError

Methods

from :: Lens PresenceError (Maybe Jid)

to :: Lens PresenceError (Maybe Jid)

lang :: Lens PresenceError (Maybe LangTag)

sid :: Lens PresenceError (Maybe Text)

payloadT :: Traversal PresenceError Element

IsStanza Presence

Methods

from :: Lens Presence (Maybe Jid)

to :: Lens Presence (Maybe Jid)

lang :: Lens Presence (Maybe LangTag)

sid :: Lens Presence (Maybe Text)

payloadT :: Traversal Presence Element

IsStanza MessageError

Methods

from :: Lens MessageError (Maybe Jid)

to :: Lens MessageError (Maybe Jid)

lang :: Lens MessageError (Maybe LangTag)

sid :: Lens MessageError (Maybe Text)

payloadT :: Traversal MessageError Element

IsStanza Message

Methods

from :: Lens Message (Maybe Jid)

to :: Lens Message (Maybe Jid)

lang :: Lens Message (Maybe LangTag)

sid :: Lens Message (Maybe Text)

payloadT :: Traversal Message Element

IsStanza IQError

Methods

from :: Lens IQError (Maybe Jid)

to :: Lens IQError (Maybe Jid)

lang :: Lens IQError (Maybe LangTag)

sid :: Lens IQError (Maybe Text)

payloadT :: Traversal IQError Element

IsStanza IQResult

Methods

from :: Lens IQResult (Maybe Jid)

to :: Lens IQResult (Maybe Jid)

lang :: Lens IQResult (Maybe LangTag)

sid :: Lens IQResult (Maybe Text)

payloadT :: Traversal IQResult Element

IsStanza IQRequest

Methods

from :: Lens IQRequest (Maybe Jid)

to :: Lens IQRequest (Maybe Jid)

lang :: Lens IQRequest (Maybe LangTag)

sid :: Lens IQRequest (Maybe Text)

payloadT :: Traversal IQRequest Element

IsStanza Stanza

Methods

from :: Lens Stanza (Maybe Jid)

to :: Lens Stanza (Maybe Jid)

lang :: Lens Stanza (Maybe LangTag)

sid :: Lens Stanza (Maybe Text)

payloadT :: Traversal Stanza Element

class HasStanzaPayload s p | s -> p where

Minimal complete definition

payload

Methods

payload :: Lens s p

Payload element(s) of the stanza. Since the amount of elements possible in a stanza vary by type, this lens can't be used with a general Stanza. There is, however, a more general Traversable that works with all stanzas (including Stanza): payloadT

Instances

HasStanzaPayload IQRequest Element

Methods

payload :: Lens IQRequest Element

HasStanzaPayload PresenceError [Element]

Methods

payload :: Lens PresenceError [Element]

HasStanzaPayload Presence [Element]

Methods

payload :: Lens Presence [Element]

HasStanzaPayload MessageError [Element]

Methods

payload :: Lens MessageError [Element]

HasStanzaPayload Message [Element]

Methods

payload :: Lens Message [Element]

HasStanzaPayload IQError (Maybe Element)

Methods

payload :: Lens IQError (Maybe Element)

HasStanzaPayload IQResult (Maybe Element)

Methods

payload :: Lens IQResult (Maybe Element)

class IsErrorStanza s where

Minimal complete definition

stanzaError

Methods

stanzaError :: Lens s StanzaError

Error element of the stanza

Instances

IsErrorStanza PresenceError

Methods

stanzaError :: Lens PresenceError StanzaError

IsErrorStanza MessageError

Methods

stanzaError :: Lens MessageError StanzaError

IsErrorStanza IQError

Methods

stanzaError :: Lens IQError StanzaError

messageTypeL :: Lens Message MessageType

presenceTypeL :: Lens Presence PresenceType

iqRequestTypeL :: Lens IQRequest IQRequestType

StanzaError

stanzaErrorTypeL :: Lens StanzaError StanzaErrorType

stanzaErrorConditionL :: Lens StanzaError StanzaErrorCondition

stanzaErrorTextL :: Lens StanzaError (Maybe (Maybe LangTag, NonemptyText))

stanzaErrorApplL :: Lens StanzaError (Maybe Element)

Stream

Stream Features

featureTlsL :: Lens StreamFeatures (Maybe Bool)

featureMechanismsL :: Lens StreamFeatures [Text]

featureRosterVerL :: Lens StreamFeatures (Maybe Bool)

featurePreApprovalL :: Lens StreamFeatures Bool

featuresOtherL :: Lens StreamFeatures [Element]

StreamConfiguration

preferredLangL :: Lens StreamConfiguration (Maybe LangTag)

toJidL :: Lens StreamConfiguration (Maybe (Jid, Bool))

connectionDetailsL :: Lens StreamConfiguration ConnectionDetails

resolvConfL :: Lens StreamConfiguration ResolvConf

tlsBehaviourL :: Lens StreamConfiguration TlsBehaviour

tlsParamsL :: Lens StreamConfiguration ClientParams

TLS parameters

clientServerIdentificationL :: Lens ClientParams (String, ByteString)

tlsServerIdentificationL :: Lens SessionConfiguration (String, ByteString)

Access clientServerIdentification inside tlsParams inside streamConfiguration

clientSupportedL :: Lens ClientParams Supported

supportedCiphersL :: Lens Supported [Cipher]

supportedVersionsL :: Lens Supported [Version]

tlsSupportedCiphersL :: Lens SessionConfiguration [Cipher]

Access supportedCiphers inside clientSupported inside tlsParams

tlsSupportedVersionsL :: Lens SessionConfiguration [Version]

Access supportedVersions inside clientSupported inside tlsParams

clientUseServerNameIndicationL :: Lens ClientParams Bool

tlsUseNameIndicationL :: Lens SessionConfiguration Bool

Access clientUseServerNameIndication inside tlsParams

SessionConfiguration

streamConfigurationL :: Lens SessionConfiguration StreamConfiguration

onConnectionClosedL :: Lens SessionConfiguration (Session -> XmppFailure -> IO ())

sessionStanzaIDsL :: Lens SessionConfiguration (IO (IO Text))

ensableRosterL :: Lens SessionConfiguration Bool

onRosterPushL :: Lens SessionConfiguration (Maybe RosterPushCallback)

pluginsL :: Lens SessionConfiguration [Plugin]

onPresenceChangeL :: Lens SessionConfiguration (Maybe (Jid -> PeerStatus -> PeerStatus -> IO ()))

IM

Roster

Roster

verL :: Lens Roster (Maybe Text)

itemsL :: Lens Roster (Map Jid Item)

Item

riApprovedL :: Lens Item Bool

riAskL :: Lens Item Bool

riJidL :: Lens Item Jid

riNameL :: Lens Item (Maybe Text)

riSubscriptionL :: Lens Item Subscription

riGroupsL :: Lens Item [Text]

QueryItem

qiApprovedL :: Lens QueryItem (Maybe Bool)

qiAskL :: Lens QueryItem Bool

qiJidL :: Lens QueryItem Jid

qiNameL :: Lens QueryItem (Maybe Text)

qiSubscriptionL :: Lens QueryItem (Maybe Subscription)

qiGroupsL :: Lens QueryItem [Text]

Query

queryVerL :: Lens Query (Maybe Text)

queryItemsL :: Lens Query [QueryItem]

IM Message

MessageBody

bodyLangL :: Lens MessageBody (Maybe LangTag)

bodyContentL :: Lens MessageBody Text

MessageThread

threadIdL :: Lens MessageThread Text

threadParentL :: Lens MessageThread (Maybe Text)

MessageSubject

subjectLangL :: Lens MessageSubject (Maybe LangTag)

subjectContentL :: Lens MessageSubject Text

InstantMessage

imThreadL :: Lens InstantMessage (Maybe MessageThread)

imSubjectL :: Lens InstantMessage [MessageSubject]

imBodyL :: Lens InstantMessage [MessageBody]

IMPresence

showStatusL :: Lens IMPresence (Maybe ShowStatus)

statusL :: Lens IMPresence (Maybe Text)

priorityL :: Lens IMPresence (Maybe Int)