From 97871addab560b785468c09fc82df285d699d5c6 Mon Sep 17 00:00:00 2001 From: Matvey Aksenov Date: Sat, 11 Apr 2015 16:22:29 +0000 Subject: [PATCH] Update haddock documentation --- Ldap-Client.html | 6 +-- ldap-client.haddock | Bin 94042 -> 94042 bytes mini_Ldap-Client.html | 2 +- src/Ldap-Client.html | 98 +++++++++++++++++++++--------------------- 4 files changed, 53 insertions(+), 53 deletions(-) diff --git a/Ldap-Client.html b/Ldap-Client.html index 3ef285b..0639c3f 100644 --- a/Ldap-Client.html +++ b/Ldap-Client.html @@ -1,11 +1,11 @@ Ldap.Client

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client

Description

Pure Haskell LDAP client library.

Synopsis

Documentation

data Host Source

LDAP host.

Constructors

Plain String

Plain LDAP. Do not use!

Insecure String

LDAP over TLS without the certificate validity check. - Only use for testing!

Secure String

LDAP over TLS. Use!

Instances

data Ldap Source

A token. All functions that interact with the Directory require one.

Instances

data LdapError Source

Various failures that can happen when working with LDAP.

Constructors

IOError IOError

Network failure.

ParseError ASN1Error

Invalid ASN.1 data received from the server.

ResponseError ResponseError

An LDAP operation failed.

DisconnectError Disconnect

Notice of Disconnection has been received.

Instances

data ResponseError Source

Response indicates a failed operation.

Constructors

ResponseInvalid Request Response

LDAP server did not follow the protocol, so ldap-client couldn't make sense of the response.

ResponseErrorCode Request ResultCode Dn Text

The response contains a result code indicating failure and an error message.

Instances

data ResultCode Source

LDAP operation's result.

Constructors

Success 
OperationError 
ProtocolError 
TimeLimitExceeded 
SizeLimitExceeded 
CompareFalse 
CompareTrue 
AuthMethodNotSupported 
StrongerAuthRequired 
Referral 
AdminLimitExceeded 
UnavailableCriticalExtension 
ConfidentialityRequired 
SaslBindInProgress 
NoSuchAttribute 
UndefinedAttributeType 
InappropriateMatching 
ConstraintViolation 
AttributeOrValueExists 
InvalidAttributeSyntax 
NoSuchObject 
AliasProblem 
InvalidDNSyntax 
AliasDereferencingProblem 
InappropriateAuthentication 
InvalidCredentials 
InsufficientAccessRights 
Busy 
Unavailable 
UnwillingToPerform 
LoopDetect 
NamingViolation 
ObjectClassViolation 
NotAllowedOnNonLeaf 
NotAllowedOnRDN 
EntryAlreadyExists 
ObjectClassModsProhibited 
AffectsMultipleDSAs 
Other 

Instances

data Async a Source

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

Instances

with :: Host -> PortNumber -> (Ldap -> IO a) -> IO (Either LdapError a) Source

The entrypoint into LDAP.

It catches all LDAP-related exceptions.

Bind

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.

Search

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

Perform the Search operation synchronously. Raises ResponseError on failures.

data SearchEntry Source

Entry found during the Search.

Constructors

SearchEntry !Dn !(AttrList []) 

Instances

Search modifiers

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

Monoid (Mod a) Source 
Semigroup (Mod a) Source 

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. +

ldap-client-0.1.0: Pure Haskell LDAP Client Library

Safe HaskellNone
LanguageHaskell2010

Ldap.Client

Description

Pure Haskell LDAP client library.

Synopsis

Documentation

with :: Host -> PortNumber -> (Ldap -> IO a) -> IO (Either LdapError a) Source

The entrypoint into LDAP.

It catches all LDAP-related exceptions.

data Host Source

LDAP host.

Constructors

Plain String

Plain LDAP. Do not use!

Insecure String

LDAP over TLS without the certificate validity check. + Only use for testing!

Secure String

LDAP over TLS. Use!

Instances

data PortNumber :: *

Instances

data Ldap Source

A token. All functions that interact with the Directory require one.

Instances

data LdapError Source

Various failures that can happen when working with LDAP.

Constructors

IOError IOError

Network failure.

ParseError ASN1Error

Invalid ASN.1 data received from the server.

ResponseError ResponseError

An LDAP operation failed.

DisconnectError Disconnect

Notice of Disconnection has been received.

Instances

data ResponseError Source

Response indicates a failed operation.

Constructors

ResponseInvalid Request Response

LDAP server did not follow the protocol, so ldap-client couldn't make sense of the response.

ResponseErrorCode Request ResultCode Dn Text

The response contains a result code indicating failure and an error message.

Instances

data ResultCode Source

LDAP operation's result.

Constructors

Success 
OperationError 
ProtocolError 
TimeLimitExceeded 
SizeLimitExceeded 
CompareFalse 
CompareTrue 
AuthMethodNotSupported 
StrongerAuthRequired 
Referral 
AdminLimitExceeded 
UnavailableCriticalExtension 
ConfidentialityRequired 
SaslBindInProgress 
NoSuchAttribute 
UndefinedAttributeType 
InappropriateMatching 
ConstraintViolation 
AttributeOrValueExists 
InvalidAttributeSyntax 
NoSuchObject 
AliasProblem 
InvalidDNSyntax 
AliasDereferencingProblem 
InappropriateAuthentication 
InvalidCredentials 
InsufficientAccessRights 
Busy 
Unavailable 
UnwillingToPerform 
LoopDetect 
NamingViolation 
ObjectClassViolation 
NotAllowedOnNonLeaf 
NotAllowedOnRDN 
EntryAlreadyExists 
ObjectClassModsProhibited 
AffectsMultipleDSAs 
Other 

Instances

data Async a Source

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

Instances

Bind

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.

Search

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

Perform the Search operation synchronously. Raises ResponseError on failures.

data SearchEntry Source

Entry found during the Search.

Constructors

SearchEntry !Dn !(AttrList []) 

Instances

Search modifiers

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

Monoid (Mod a) Source 
Semigroup (Mod a) Source 

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

Modify

modify :: Ldap -> Dn -> [Operation] -> IO () Source

Perform the Modify operation synchronously. Raises ResponseError on failures.

data Operation Source

Type of modification being performed.

Constructors

Delete Attr [AttrValue]

Delete values from the attribute. Deletes the attribute if the list is empty or all current values are listed.

Add Attr [AttrValue]

Add values to the attribute, creating it if necessary.

Replace Attr [AttrValue]

Replace all existing values of the attribute with the new list. Deletes the attribute if the list is empty.

Instances

Add

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

Perform the Add operation synchronously. Raises ResponseError on failures.

Delete

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

Perform the Delete operation synchronously. Raises ResponseError on failures.

ModifyDn

newtype RelativeDn Source

A component of Dn.

Constructors

RelativeDn Text 

Instances

modifyDn :: Ldap -> Dn -> RelativeDn -> Bool -> Maybe Dn -> IO () Source

Perform the Modify DN operation synchronously. Raises ResponseError on failures.

Compare

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

Perform the Compare operation synchronously. Raises ResponseError on failures.

Extended

newtype Oid Source

Globally unique LDAP object identifier.

Constructors

Oid Text 

Instances

extended :: Ldap -> Oid -> Maybe ByteString -> IO () Source

Perform the Extended operation synchronously. Raises ResponseError on failures.

Waiting for completion

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

Wait for operation completion.

Miscellanous

newtype Dn Source

Unique identifier of an LDAP entry.

Constructors

Dn Text 

Instances

newtype Attr Source

Attribute name.

Constructors

Attr Text 

Instances

type AttrValue = ByteString Source

Attribute value.

type AttrList f = [(Attr, f AttrValue)] Source

List of attributes and their values. f is the structure these - values are in, e.g. NonEmpty.

Re-exports

data NonEmpty a :: * -> *

Instances

Monad NonEmpty 
Functor NonEmpty 
MonadFix NonEmpty 
Applicative NonEmpty 
Foldable NonEmpty 
Traversable NonEmpty 
Generic1 NonEmpty 
MonadZip NonEmpty 
IsList (NonEmpty a) 
Eq a => Eq (NonEmpty a) 
Data a => Data (NonEmpty a) 
Ord a => Ord (NonEmpty a) 
Read a => Read (NonEmpty a) 
Show a => Show (NonEmpty a) 
Generic (NonEmpty a) 
NFData a => NFData (NonEmpty a) 
Hashable a => Hashable (NonEmpty a) 
ToAsn1 a => ToAsn1 (NonEmpty a) 
Semigroup (NonEmpty a) 
type Rep1 NonEmpty = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector Par1) (S1 NoSelector (Rec1 [])))) 
type Rep (NonEmpty a) = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector (Rec0 a)) (S1 NoSelector (Rec0 [a])))) 
type Item (NonEmpty a) = a 

data PortNumber :: *

Instances

\ No newline at end of file + values are in, e.g. NonEmpty.

Re-exports

data NonEmpty a :: * -> *

Instances

Monad NonEmpty 
Functor NonEmpty 
MonadFix NonEmpty 
Applicative NonEmpty 
Foldable NonEmpty 
Traversable NonEmpty 
Generic1 NonEmpty 
MonadZip NonEmpty 
IsList (NonEmpty a) 
Eq a => Eq (NonEmpty a) 
Data a => Data (NonEmpty a) 
Ord a => Ord (NonEmpty a) 
Read a => Read (NonEmpty a) 
Show a => Show (NonEmpty a) 
Generic (NonEmpty a) 
NFData a => NFData (NonEmpty a) 
Hashable a => Hashable (NonEmpty a) 
ToAsn1 a => ToAsn1 (NonEmpty a) 
Semigroup (NonEmpty a) 
type Rep1 NonEmpty = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector Par1) (S1 NoSelector (Rec1 [])))) 
type Rep (NonEmpty a) = D1 D1NonEmpty (C1 C1_0NonEmpty ((:*:) (S1 NoSelector (Rec0 a)) (S1 NoSelector (Rec0 [a])))) 
type Item (NonEmpty a) = a 
\ No newline at end of file diff --git a/ldap-client.haddock b/ldap-client.haddock index 9a8f92db74ad815352b28ca5e5add6d3ae9bfb7f..31ae62ca372a2d3daddab682e38bba15e44a0084 100644 GIT binary patch delta 33 rcmV++0N(%F-UZs;1%R{x-arBOlL?|5m-0XX#Fx530ou2iLIJ`o7-J8b delta 47 zcmcb0kM-6))`l&N_Z)Z^GcYhL0pg`Vylnbs2gcKk->2_(WW3AFz%X(9bSK8cIsmnw B5r6;y diff --git a/mini_Ldap-Client.html b/mini_Ldap-Client.html index f6ea8c4..8dbfb4a 100644 --- a/mini_Ldap-Client.html +++ b/mini_Ldap-Client.html @@ -1,4 +1,4 @@ Ldap.Client

Ldap.Client

data Host

data Ldap

data LdapError

data ResponseError

data ResultCode

data Async a

with

Bind

data Password

bind

Search

search

data SearchEntry

Search modifiers

data Search

data Mod a

data Scope

scope

size

time

typesOnly

data DerefAliases

derefAliases

data Filter

Modify

modify

data Operation

Add

add

Delete

delete

ModifyDn

data RelativeDn

modifyDn

Compare

compare

Extended

data Oid

extended

Waiting for completion

wait

Miscellanous

data Dn

data Attr

type AttrValue

type AttrList f

Re-exports

data NonEmpty a

data PortNumber

\ No newline at end of file +

Ldap.Client

with

data Host

data PortNumber

data Ldap

data LdapError

data ResponseError

data ResultCode

data Async a

Bind

data Password

bind

Search

search

data SearchEntry

Search modifiers

data Search

data Mod a

data Scope

scope

size

time

typesOnly

data DerefAliases

derefAliases

data Filter

Modify

modify

data Operation

Add

add

Delete

delete

ModifyDn

data RelativeDn

modifyDn

Compare

compare

Extended

data Oid

extended

Waiting for completion

wait

Miscellanous

data Dn

data Attr

type AttrValue

type AttrList f

Re-exports

data NonEmpty a

\ No newline at end of file diff --git a/src/Ldap-Client.html b/src/Ldap-Client.html index 32b4b9e..58ecd01 100644 --- a/src/Ldap-Client.html +++ b/src/Ldap-Client.html @@ -13,55 +13,55 @@ {-# LANGUAGE NamedFieldPuns #-} -- | Pure Haskell LDAP client library. module Ldap.Client - ( Host(..) - , Ldap - , LdapError(..) - , ResponseError(..) - , Type.ResultCode(..) - , Async - , with - -- * Bind - , Password(..) - , bind - -- * Search - , search - , SearchEntry(..) - -- ** Search modifiers - , Search - , Mod - , Type.Scope(..) - , scope - , size - , time - , typesOnly - , Type.DerefAliases(..) - , derefAliases - , Filter(..) - -- * Modify - , modify - , Operation(..) - -- * Add - , add - -- * Delete - , delete - -- * ModifyDn - , RelativeDn(..) - , modifyDn - -- * Compare - , compare - -- * Extended - , Oid(..) - , extended - -- * Waiting for completion - , wait - -- * Miscellanous - , Dn(..) - , Attr(..) - , AttrValue - , AttrList - -- * Re-exports - , NonEmpty - , PortNumber + ( with + , Host(..) + , PortNumber + , Ldap + , LdapError(..) + , ResponseError(..) + , Type.ResultCode(..) + , Async + -- * Bind + , Password(..) + , bind + -- * Search + , search + , SearchEntry(..) + -- ** Search modifiers + , Search + , Mod + , Type.Scope(..) + , scope + , size + , time + , typesOnly + , Type.DerefAliases(..) + , derefAliases + , Filter(..) + -- * Modify + , modify + , Operation(..) + -- * Add + , add + -- * Delete + , delete + -- * ModifyDn + , RelativeDn(..) + , modifyDn + -- * Compare + , compare + -- * Extended + , Oid(..) + , extended + -- * Waiting for completion + , wait + -- * Miscellanous + , Dn(..) + , Attr(..) + , AttrValue + , AttrList + -- * Re-exports + , NonEmpty ) where #if __GLASGOW_HASKELL__ < 710