| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Ldap.Client.Search
Description
Search operation.
This operation comes in four flavours:
- synchronous, exception throwing (
search) - synchronous, returning
EitherResponseError()(searchEither) - asynchronous,
IObased (searchAsync) - asynchronous,
STMbased (searchAsyncSTM)
Of those, the first one (search) is probably the most useful for the typical usecase.
- search :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO [SearchEntry]
- searchEither :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO (Either ResponseError [SearchEntry])
- searchAsync :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO (Async [SearchEntry])
- searchAsyncSTM :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> STM (Async [SearchEntry])
- data Search
- data Mod a
- data Scope
- scope :: Scope -> Mod Search
- size :: Int32 -> Mod Search
- time :: Int32 -> Mod Search
- typesOnly :: Bool -> Mod Search
- derefAliases :: DerefAliases -> Mod Search
- data Filter
- data SearchEntry = SearchEntry Dn (AttrList [])
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.
Constructors
| BaseObject | |
| SingleLevel | |
| WholeSubtree |
derefAliases :: DerefAliases -> Mod Search Source