7 lines
6.4 KiB
HTML
7 lines
6.4 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Ldap.Client.Delete</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
|
|
window.onload = function () {pageLoad();setSynopsis("mini_Ldap-Client-Delete.html");};
|
|
//]]>
|
|
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Ldap-Client-Delete.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">ldap-client-0.1.0: Pure Haskell LDAP Client Library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Ldap.Client.Delete</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p><a href="https://tools.ietf.org/html/rfc4511#section-4.8">Delete</a> operation.</p><p>This operation comes in four flavours:</p><ul><li>synchronous, exception throwing (<code><a href="Ldap-Client-Delete.html#v:delete">delete</a></code>)</li><li>synchronous, returning <code><a href="http://hackage.haskell.org/package/base/docs/Data-Either.html#t:Either">Either</a></code> <code><a href="Ldap-Client-Internal.html#t:ResponseError">ResponseError</a></code> <code>()</code> (<code><a href="Ldap-Client-Delete.html#v:deleteEither">deleteEither</a></code>)</li><li>asynchronous, <code><a href="http://hackage.haskell.org/package/base/docs/System-IO.html#t:IO">IO</a></code> based (<code><a href="Ldap-Client-Delete.html#v:deleteAsync">deleteAsync</a></code>)</li><li>asynchronous, <code><a href="http://hackage.haskell.org/package/base/docs/GHC-Conc.html#t:STM">STM</a></code> based (<code><a href="Ldap-Client-Delete.html#v:deleteAsyncSTM">deleteAsyncSTM</a></code>)</li></ul><p>Of those, the first one (<code><a href="Ldap-Client-Delete.html#v:delete">delete</a></code>) is probably the most useful for the typical usecase.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:delete">delete</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:deleteEither">deleteEither</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/System-IO.html#t:IO">IO</a> (<a href="http://hackage.haskell.org/package/base/docs/Data-Either.html#t:Either">Either</a> <a href="Ldap-Client-Internal.html#t:ResponseError">ResponseError</a> ())</li><li class="src short"><a href="#v:deleteAsync">deleteAsync</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/System-IO.html#t:IO">IO</a> (<a href="Ldap-Client-Internal.html#t:Async">Async</a> ())</li><li class="src short"><a href="#v:deleteAsyncSTM">deleteAsyncSTM</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/GHC-Conc.html#t:STM">STM</a> (<a href="Ldap-Client-Internal.html#t:Async">Async</a> ())</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:delete" class="def">delete</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/System-IO.html#t:IO">IO</a> () <a href="src/Ldap-Client-Delete.html#delete" class="link">Source</a></p><div class="doc"><p>Perform the Delete operation synchronously. Raises <code><a href="Ldap-Client-Internal.html#t:ResponseError">ResponseError</a></code> on failures.</p></div></div><div class="top"><p class="src"><a name="v:deleteEither" class="def">deleteEither</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/System-IO.html#t:IO">IO</a> (<a href="http://hackage.haskell.org/package/base/docs/Data-Either.html#t:Either">Either</a> <a href="Ldap-Client-Internal.html#t:ResponseError">ResponseError</a> ()) <a href="src/Ldap-Client-Delete.html#deleteEither" class="link">Source</a></p><div class="doc"><p>Perform the Delete operation synchronously. Returns <code>Left e</code> where
|
|
<code>e</code> is a <code><a href="Ldap-Client-Internal.html#t:ResponseError">ResponseError</a></code> on failures.</p></div></div><div class="top"><p class="src"><a name="v:deleteAsync" class="def">deleteAsync</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/System-IO.html#t:IO">IO</a> (<a href="Ldap-Client-Internal.html#t:Async">Async</a> ()) <a href="src/Ldap-Client-Delete.html#deleteAsync" class="link">Source</a></p><div class="doc"><p>Perform the Delete operation asynchronously. Call <code><a href="Ldap-Client.html#v:wait">wait</a></code> to wait
|
|
for its completion.</p></div></div><div class="top"><p class="src"><a name="v:deleteAsyncSTM" class="def">deleteAsyncSTM</a> :: <a href="Ldap-Client-Internal.html#t:Ldap">Ldap</a> -> <a href="Ldap-Client-Internal.html#t:Dn">Dn</a> -> <a href="http://hackage.haskell.org/package/base/docs/GHC-Conc.html#t:STM">STM</a> (<a href="Ldap-Client-Internal.html#t:Async">Async</a> ()) <a href="src/Ldap-Client-Delete.html#deleteAsyncSTM" class="link">Source</a></p><div class="doc"><p>Perform the Delete operation asynchronously.</p><p>Don't wait for its completion (with <code><a href="Ldap-Client.html#v:waitSTM">waitSTM</a></code>) in the
|
|
same transaction you've performed it in.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.0</p></div></body></html> |