diff --git a/Ldap-Client-Add.html b/Ldap-Client-Add.html index 766ba28..b78db56 100644 --- a/Ldap-Client-Add.html +++ b/Ldap-Client-Add.html @@ -1,10 +1,10 @@ Ldap.Client.Add

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Add

Description

Add operation.

This operation comes in four flavours:

Of those, the first one (add) is probably the most useful for the typical usecase.

Synopsis

Documentation

add :: Ldap -> Dn -> AttrList NonEmpty -> IO () Source

Perform the Add operation synchronously. Raises ResponseError on failures.

addEither :: Ldap -> Dn -> AttrList NonEmpty -> IO (Either ResponseError ()) Source

Perform the Add operation synchronously. Returns Left e where - e is a ResponseError on failures.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

addAsync :: Ldap -> Dn -> AttrList NonEmpty -> IO (Async ()) Source

Perform the Add operation asynchronously. Call wait to wait +

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Add

Description

Add operation.

This operation comes in four flavours:

Of those, the first one (add) is probably the most useful for the typical usecase.

Documentation

add :: Ldap -> Dn -> AttrList NonEmpty -> IO () Source

Perform the Add operation synchronously. Raises ResponseError on failures.

addEither :: Ldap -> Dn -> AttrList NonEmpty -> IO (Either ResponseError ()) Source

Perform the Add operation synchronously. Returns Left e where + e is a ResponseError on failures.

addAsync :: Ldap -> Dn -> AttrList NonEmpty -> IO (Async ()) Source

Perform the Add operation asynchronously. Call wait to wait for its completion.

addAsyncSTM :: Ldap -> Dn -> AttrList NonEmpty -> STM (Async ()) Source

Perform the Add operation asynchronously.

Don't wait for its completion (with waitSTM) in the - same transaction you've performed it in.

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was + same transaction you've performed it in.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was requested in! To give LDAP the chance to respond to it that transaction should commit. After that, applying waitSTM to the corresponding Async starts to make sense.

\ No newline at end of file diff --git a/Ldap-Client-Bind.html b/Ldap-Client-Bind.html index 9d38af0..a914a03 100644 --- a/Ldap-Client-Bind.html +++ b/Ldap-Client-Bind.html @@ -1,10 +1,10 @@ Ldap.Client.Bind

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Bind

Description

Bind operation.

This operation comes in four flavours:

Of those, the first one (bind) is probably the most useful for the typical usecase.

Documentation

newtype Password Source

User's password.

Constructors

Password ByteString 

Instances

bind :: Ldap -> Dn -> Password -> IO () Source

Perform the Bind operation synchronously. Raises ResponseError on failures.

bindEither :: Ldap -> Dn -> Password -> IO (Either ResponseError ()) Source

Perform the Bind operation synchronously. Returns Left e where - e is a ResponseError on failures.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

bindAsync :: Ldap -> Dn -> Password -> IO (Async ()) Source

Perform the Bind operation asynchronously. Call wait to wait +

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Bind

Description

Bind operation.

This operation comes in four flavours:

Of those, the first one (bind) is probably the most useful for the typical usecase.

Documentation

newtype Password Source

User's password.

Constructors

Password ByteString 

Instances

bind :: Ldap -> Dn -> Password -> IO () Source

Perform the Bind operation synchronously. Raises ResponseError on failures.

bindEither :: Ldap -> Dn -> Password -> IO (Either ResponseError ()) Source

Perform the Bind operation synchronously. Returns Left e where + e is a ResponseError on failures.

bindAsync :: Ldap -> Dn -> Password -> IO (Async ()) Source

Perform the Bind operation asynchronously. Call wait to wait for its completion.

bindAsyncSTM :: Ldap -> Dn -> Password -> STM (Async ()) Source

Perform the Bind operation asynchronously.

Don't wait for its completion (with waitSTM) in the - same transaction you've performed it in.

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was + same transaction you've performed it in.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was requested in! To give LDAP the chance to respond to it that transaction should commit. After that, applying waitSTM to the corresponding Async starts to make sense.

\ No newline at end of file diff --git a/Ldap-Client-Compare.html b/Ldap-Client-Compare.html index 9db2630..783e2ab 100644 --- a/Ldap-Client-Compare.html +++ b/Ldap-Client-Compare.html @@ -2,10 +2,10 @@ window.onload = function () {pageLoad();setSynopsis("mini_Ldap-Client-Compare.html");}; //]]>

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Compare

Description

Compare operation.

This operation comes in four flavours:

Of those, the first one (compare) is probably the most useful for the - typical usecase.

Documentation

compare :: Ldap -> Dn -> Attr -> AttrValue -> IO Bool Source

Perform the Compare operation synchronously. Raises ResponseError on failures.

compareEither :: Ldap -> Dn -> Attr -> AttrValue -> IO (Either ResponseError Bool) Source

Perform the Compare operation synchronously. Returns Left e where - e is a ResponseError on failures.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

compareAsync :: Ldap -> Dn -> Attr -> AttrValue -> IO (Async Bool) Source

Perform the Compare operation asynchronously. Call wait to wait + typical usecase.

Documentation

compare :: Ldap -> Dn -> Attr -> AttrValue -> IO Bool Source

Perform the Compare operation synchronously. Raises ResponseError on failures.

compareEither :: Ldap -> Dn -> Attr -> AttrValue -> IO (Either ResponseError Bool) Source

Perform the Compare operation synchronously. Returns Left e where + e is a ResponseError on failures.

compareAsync :: Ldap -> Dn -> Attr -> AttrValue -> IO (Async Bool) Source

Perform the Compare operation asynchronously. Call wait to wait for its completion.

compareAsyncSTM :: Ldap -> Dn -> Attr -> AttrValue -> STM (Async Bool) Source

Perform the Compare operation asynchronously.

Don't wait for its completion (with waitSTM) in the - same transaction you've performed it in.

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was + same transaction you've performed it in.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was requested in! To give LDAP the chance to respond to it that transaction should commit. After that, applying waitSTM to the corresponding Async starts to make sense.

\ No newline at end of file diff --git a/Ldap-Client-Delete.html b/Ldap-Client-Delete.html index c02c890..febc429 100644 --- a/Ldap-Client-Delete.html +++ b/Ldap-Client-Delete.html @@ -1,10 +1,10 @@ Ldap.Client.Delete

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Delete

Description

Delete operation.

This operation comes in four flavours:

Of those, the first one (delete) is probably the most useful for the typical usecase.

Synopsis

Documentation

delete :: Ldap -> Dn -> IO () Source

Perform the Delete operation synchronously. Raises ResponseError on failures.

deleteEither :: Ldap -> Dn -> IO (Either ResponseError ()) Source

Perform the Delete operation synchronously. Returns Left e where - e is a ResponseError on failures.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

deleteAsync :: Ldap -> Dn -> IO (Async ()) Source

Perform the Delete operation asynchronously. Call wait to wait +

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Delete

Description

Delete operation.

This operation comes in four flavours:

Of those, the first one (delete) is probably the most useful for the typical usecase.

Synopsis

Documentation

delete :: Ldap -> Dn -> IO () Source

Perform the Delete operation synchronously. Raises ResponseError on failures.

deleteEither :: Ldap -> Dn -> IO (Either ResponseError ()) Source

Perform the Delete operation synchronously. Returns Left e where + e is a ResponseError on failures.

deleteAsync :: Ldap -> Dn -> IO (Async ()) Source

Perform the Delete operation asynchronously. Call wait to wait for its completion.

deleteAsyncSTM :: Ldap -> Dn -> STM (Async ()) Source

Perform the Delete operation asynchronously.

Don't wait for its completion (with waitSTM) in the - same transaction you've performed it in.

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was + same transaction you've performed it in.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was requested in! To give LDAP the chance to respond to it that transaction should commit. After that, applying waitSTM to the corresponding Async starts to make sense.

\ No newline at end of file diff --git a/Ldap-Client-Search.html b/Ldap-Client-Search.html index 89e5fd7..3e3455a 100644 --- a/Ldap-Client-Search.html +++ b/Ldap-Client-Search.html @@ -1,15 +1,15 @@ Ldap.Client.Search

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Search

Description

Search operation.

This operation comes in four flavours:

Of those, the first one (search) is probably the most useful for the typical usecase.

Documentation

search :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO [SearchEntry] Source

Perform the Search operation synchronously. Raises ResponseError on failures.

searchEither :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO (Either ResponseError [SearchEntry]) Source

Perform the Search operation synchronously. Returns Left e where - e is a ResponseError on failures.

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

searchAsync :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO (Async [SearchEntry]) Source

Perform the Search operation asynchronously. Call wait to wait +

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client.Search

Description

Search operation.

This operation comes in four flavours:

Of those, the first one (search) is probably the most useful for the typical usecase.

Documentation

search :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO [SearchEntry] Source

Perform the Search operation synchronously. Raises ResponseError on failures.

searchEither :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO (Either ResponseError [SearchEntry]) Source

Perform the Search operation synchronously. Returns Left e where + e is a ResponseError on failures.

searchAsync :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO (Async [SearchEntry]) Source

Perform the Search operation asynchronously. Call wait to wait for its completion.

searchAsyncSTM :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> STM (Async [SearchEntry]) Source

Perform the Search operation asynchronously.

Don't wait for its completion (with waitSTM) in the same transaction you've performed it in.

data Search Source

Search options. Use Mod to change some of those.

Instances

data Mod a Source

Search modifier. Combine using Semigroup and/or Monoid instance.

Instances

data Scope Source

Scope of the search to be performed.

Constructors

BaseObject

Constrained to the entry named by baseObject.

SingleLevel

Constrained to the immediate subordinates of the entry named by baseObject.

WholeSubtree

Constrained to the entry named by baseObject and to all its subordinates.

Instances

scope :: Scope -> Mod Search Source

Scope of the search (default: WholeSubtree).

size :: Int32 -> Mod Search Source

Maximum number of entries to be returned as a result of the Search. No limit if the value is 0 (default: 0).

time :: Int32 -> Mod Search Source

Maximum time (in seconds) allowed for the Search. No limit if the value is 0 (default: 0).

typesOnly :: Bool -> Mod Search Source

Whether Search results are to contain just attribute descriptions, or both attribute descriptions and values (default: False).

data DerefAliases Source

An indicator as to whether or not alias entries (as defined in [RFC4512]) are to be dereferenced during stages of the Search - operation.

Constructors

NeverDerefAliases

Do not dereference aliases in searching or in locating the base object of the Search.

DerefInSearching

While searching subordinates of the base object, dereference any alias within the search scope.

DerefFindingBaseObject

Dereference aliases in locating the base object of the Search.

DerefAlways

Dereference aliases both in searching and in locating the base object of the Search.

Instances

derefAliases :: DerefAliases -> Mod Search Source

Alias dereference policy (default: NeverDerefAliases).

data Filter Source

Conditions that must be fulfilled in order for the Search to match a given entry.

Constructors

Not !Filter

Filter does not match the entry

And !(NonEmpty Filter)

All filters match the entry

Or !(NonEmpty Filter)

Any filter matches the entry

Present !Attr

Attribute is present in the entry

!Attr := !AttrValue

Attribute's value is equal to the assertion

!Attr :>= !AttrValue

Attribute's value is equal to or greater than the assertion

!Attr :<= !AttrValue

Attribute's value is equal to or less than the assertion

!Attr :~= !AttrValue

Attribute's value approximately matches the assertion

!Attr :=* !(Maybe AttrValue, [AttrValue], Maybe AttrValue)

Glob match

(Maybe Attr, Maybe Attr, Bool) ::= AttrValue

Extensible match

data SearchEntry Source

Entry found during the Search.

Constructors

SearchEntry !Dn !(AttrList []) 

Instances

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was + operation.

Constructors

NeverDerefAliases

Do not dereference aliases in searching or in locating the base object of the Search.

DerefInSearching

While searching subordinates of the base object, dereference any alias within the search scope.

DerefFindingBaseObject

Dereference aliases in locating the base object of the Search.

DerefAlways

Dereference aliases both in searching and in locating the base object of the Search.

Instances

derefAliases :: DerefAliases -> Mod Search Source

Alias dereference policy (default: NeverDerefAliases).

data Filter Source

Conditions that must be fulfilled in order for the Search to match a given entry.

Constructors

Not !Filter

Filter does not match the entry

And !(NonEmpty Filter)

All filters match the entry

Or !(NonEmpty Filter)

Any filter matches the entry

Present !Attr

Attribute is present in the entry

!Attr := !AttrValue

Attribute's value is equal to the assertion

!Attr :>= !AttrValue

Attribute's value is equal to or greater than the assertion

!Attr :<= !AttrValue

Attribute's value is equal to or less than the assertion

!Attr :~= !AttrValue

Attribute's value approximately matches the assertion

!Attr :=* !(Maybe AttrValue, [AttrValue], Maybe AttrValue)

Glob match

(Maybe Attr, Maybe Attr, Bool) ::= AttrValue

Extensible match

data SearchEntry Source

Entry found during the Search.

Constructors

SearchEntry !Dn !(AttrList []) 

Instances

data Async a Source

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

wait :: Async a -> IO (Either ResponseError a) Source

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a) Source

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was requested in! To give LDAP the chance to respond to it that transaction should commit. After that, applying waitSTM to the corresponding Async starts to make sense.

\ No newline at end of file diff --git a/ldap-client.haddock b/ldap-client.haddock index 46e9bb7..782cc6b 100644 Binary files a/ldap-client.haddock and b/ldap-client.haddock differ diff --git a/mini_Ldap-Client-Add.html b/mini_Ldap-Client-Add.html index a436d02..edda700 100644 --- a/mini_Ldap-Client-Add.html +++ b/mini_Ldap-Client-Add.html @@ -1,4 +1,4 @@ Ldap.Client.Add

Ldap.Client.Add

\ No newline at end of file +

Ldap.Client.Add

\ No newline at end of file diff --git a/mini_Ldap-Client-Bind.html b/mini_Ldap-Client-Bind.html index 2fd4666..7db5205 100644 --- a/mini_Ldap-Client-Bind.html +++ b/mini_Ldap-Client-Bind.html @@ -1,4 +1,4 @@ Ldap.Client.Bind

Ldap.Client.Bind

\ No newline at end of file +

Ldap.Client.Bind

\ No newline at end of file diff --git a/mini_Ldap-Client-Compare.html b/mini_Ldap-Client-Compare.html index 6d469ca..e80de46 100644 --- a/mini_Ldap-Client-Compare.html +++ b/mini_Ldap-Client-Compare.html @@ -1,4 +1,4 @@ Ldap.Client.Compare

Ldap.Client.Compare

\ No newline at end of file +

Ldap.Client.Compare

\ No newline at end of file diff --git a/mini_Ldap-Client-Delete.html b/mini_Ldap-Client-Delete.html index 835ddf0..4285872 100644 --- a/mini_Ldap-Client-Delete.html +++ b/mini_Ldap-Client-Delete.html @@ -1,4 +1,4 @@ Ldap.Client.Delete

Ldap.Client.Delete

\ No newline at end of file +

Ldap.Client.Delete

\ No newline at end of file diff --git a/mini_Ldap-Client-Search.html b/mini_Ldap-Client-Search.html index da7196a..faf1011 100644 --- a/mini_Ldap-Client-Search.html +++ b/mini_Ldap-Client-Search.html @@ -1,4 +1,4 @@ Ldap.Client.Search

Ldap.Client.Search

\ No newline at end of file +

Ldap.Client.Search

\ No newline at end of file diff --git a/src/Ldap-Client-Add.html b/src/Ldap-Client-Add.html index df682ea..90c67fe 100644 --- a/src/Ldap-Client-Add.html +++ b/src/Ldap-Client-Add.html @@ -23,9 +23,9 @@ module Ldap.Client.Add ( add , addEither - , Async - , addAsync - , addAsyncSTM + , addAsync + , addAsyncSTM + , Async , wait , waitSTM ) where diff --git a/src/Ldap-Client-Bind.html b/src/Ldap-Client-Bind.html index 0ae7f15..7be6637 100644 --- a/src/Ldap-Client-Bind.html +++ b/src/Ldap-Client-Bind.html @@ -24,9 +24,9 @@ ( Password(..) , bind , bindEither - , Async - , bindAsync - , bindAsyncSTM + , bindAsync + , bindAsyncSTM + , Async , wait , waitSTM ) where diff --git a/src/Ldap-Client-Compare.html b/src/Ldap-Client-Compare.html index f81bb63..8a0692b 100644 --- a/src/Ldap-Client-Compare.html +++ b/src/Ldap-Client-Compare.html @@ -24,9 +24,9 @@ module Ldap.Client.Compare ( compare , compareEither - , Async - , compareAsync - , compareAsyncSTM + , compareAsync + , compareAsyncSTM + , Async , wait , waitSTM ) where diff --git a/src/Ldap-Client-Delete.html b/src/Ldap-Client-Delete.html index ac8b547..631541f 100644 --- a/src/Ldap-Client-Delete.html +++ b/src/Ldap-Client-Delete.html @@ -23,9 +23,9 @@ module Ldap.Client.Delete ( delete , deleteEither - , Async - , deleteAsync - , deleteAsyncSTM + , deleteAsync + , deleteAsyncSTM + , Async , wait , waitSTM ) where diff --git a/src/Ldap-Client-Search.html b/src/Ldap-Client-Search.html index 40813a0..d6401be 100644 --- a/src/Ldap-Client-Search.html +++ b/src/Ldap-Client-Search.html @@ -25,20 +25,20 @@ module Ldap.Client.Search ( search , searchEither - , Async - , searchAsync - , searchAsyncSTM - , Search - , Mod - , Type.Scope(..) - , scope - , size - , time - , typesOnly - , Type.DerefAliases(..) - , derefAliases - , Filter(..) - , SearchEntry(..) + , searchAsync + , searchAsyncSTM + , Search + , Mod + , Type.Scope(..) + , scope + , size + , time + , typesOnly + , Type.DerefAliases(..) + , derefAliases + , Filter(..) + , SearchEntry(..) + , Async , wait , waitSTM ) where