-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | RFC 4918 WebDAV support
--   
--   This is a library for the Web Distributed Authoring and Versioning
--   (WebDAV) extensions to HTTP. At present it supports a very small
--   subset of client functionality.
--   
--   In addition, there is an executable, hdav, which can be used for
--   command-line operation.
@package DAV
@version 1.3.4

module Network.Protocol.HTTP.DAV
newtype DAVT (m :: Type -> Type) a
DAVT :: ExceptT String (StateT DAVContext m) a -> DAVT (m :: Type -> Type) a
[runDAVT] :: DAVT (m :: Type -> Type) a -> ExceptT String (StateT DAVContext m) a
evalDAVT :: MonadIO m => DAVURL -> DAVT m a -> m (Either String a)
withDAVContext :: MonadIO m => DAVURL -> (DAVContext -> m a) -> m a
runDAVContext :: MonadIO m => DAVContext -> DAVT m a -> m (Either String a, DAVContext)
setCreds :: forall (m :: Type -> Type). MonadIO m => ByteString -> ByteString -> DAVT m ()
setDepth :: forall (m :: Type -> Type). MonadIO m => Maybe Depth -> DAVT m ()
setResponseTimeout :: forall (m :: Type -> Type). MonadIO m => Maybe Int -> DAVT m ()
setUserAgent :: forall (m :: Type -> Type). MonadIO m => ByteString -> DAVT m ()
data DAVContext
DAVContext :: [ByteString] -> Request -> ByteString -> ByteString -> [ByteString] -> Maybe Depth -> Maybe Manager -> Maybe ByteString -> ByteString -> DAVContext
[_allowedMethods] :: DAVContext -> [ByteString]
[_baseRequest] :: DAVContext -> Request
[_basicusername] :: DAVContext -> ByteString
[_basicpassword] :: DAVContext -> ByteString
[_complianceClasses] :: DAVContext -> [ByteString]
[_depth] :: DAVContext -> Maybe Depth
[_httpManager] :: DAVContext -> Maybe Manager
[_lockToken] :: DAVContext -> Maybe ByteString
[_userAgent] :: DAVContext -> ByteString
caldavReportM :: forall (m :: Type -> Type). MonadIO m => DAVT m Document
delContentM :: forall (m :: Type -> Type). MonadIO m => DAVT m ()
getPropsM :: forall (m :: Type -> Type). MonadIO m => DAVT m Document

-- | Note that the entire request body is buffered in memory. To stream
--   large files use withContentM instead.
getContentM :: forall (m :: Type -> Type). MonadIO m => DAVT m (Maybe ByteString, ByteString)
withContentM :: forall (m :: Type -> Type) a. MonadIO m => (Response BodyReader -> IO a) -> DAVT m a
mkCol :: forall (m :: Type -> Type). (MonadIO m, MonadBase IO m, MonadCatch m) => DAVT m Bool
moveContentM :: forall (m :: Type -> Type). MonadIO m => ByteString -> DAVT m ()
putPropsM :: forall (m :: Type -> Type). MonadIO m => Document -> DAVT m ()

-- | Note that the entire request body is buffered in memory; not suitable
--   for large files.
putContentM :: forall (m :: Type -> Type). MonadIO m => (Maybe ByteString, ByteString) -> DAVT m ()

-- | To send a large file, pass eg a RequestBodyStream containing the
--   file's content.
putContentM' :: forall (m :: Type -> Type). MonadIO m => (Maybe ByteString, RequestBody) -> DAVT m ()
withLockIfPossible :: forall (m :: Type -> Type) a. (MonadIO m, MonadBase IO m) => Bool -> DAVT m a -> DAVT m a
withLockIfPossibleForDelete :: forall (m :: Type -> Type) a. (MonadIO m, MonadBase IO m) => Bool -> DAVT m a -> DAVT m a

-- | Normally, DAVT actions act on the url that is provided to eg,
--   evalDAVT. Sometimes, it's useful to adjust the url that is acted on,
--   while remaining in the same DAV session.
--   
--   inLocation temporarily adjusts the url's path, while performing a DAVT
--   action.
--   
--   For example:
--   
--   
--   import System.FilePath.Posix -- posix for url path manipulation
--   
--   mkColRecursive d = do
--     let parent = takeDirectory d
--     when (parent /= d) $
--       mkColRecursive parent
--     inDAVLocation (</> d) mkCol
--   
--   
--   Note that operations that modify the DAVContext (such as setCreds and
--   setCreds) can be run inside davLocation, but will not have any effect
--   on the calling DAVContext.
inDAVLocation :: forall (m :: Type -> Type) a. MonadIO m => (String -> String) -> DAVT m a -> DAVT m a

-- | Gets the path of the url that DAVT actions will act on.
getDAVLocation :: forall (m :: Type -> Type). Monad m => DAVT m String
mkDAVContext :: MonadIO m => DAVURL -> m DAVContext

-- | Deprecated: deprecated because http-client deprecated
--   closeManager
closeDAVContext :: MonadIO m => DAVContext -> m ()
data DAVContext
DAVContext :: [ByteString] -> Request -> ByteString -> ByteString -> [ByteString] -> Maybe Depth -> Maybe Manager -> Maybe ByteString -> ByteString -> DAVContext
[_allowedMethods] :: DAVContext -> [ByteString]
[_baseRequest] :: DAVContext -> Request
[_basicusername] :: DAVContext -> ByteString
[_basicpassword] :: DAVContext -> ByteString
[_complianceClasses] :: DAVContext -> [ByteString]
[_depth] :: DAVContext -> Maybe Depth
[_httpManager] :: DAVContext -> Maybe Manager
[_lockToken] :: DAVContext -> Maybe ByteString
[_userAgent] :: DAVContext -> ByteString
data Depth
Depth0 :: Depth
Depth1 :: Depth
DepthInfinity :: Depth
allowedMethods :: Lens' DAVContext [ByteString]
baseRequest :: Lens' DAVContext Request
basicpassword :: Lens' DAVContext ByteString
basicusername :: Lens' DAVContext ByteString
complianceClasses :: Lens' DAVContext [ByteString]
depth :: Lens' DAVContext (Maybe Depth)
httpManager :: Lens' DAVContext (Maybe Manager)
lockToken :: Lens' DAVContext (Maybe ByteString)
userAgent :: Lens' DAVContext ByteString
instance GHC.Internal.Base.Monad m => GHC.Internal.Base.Alternative (Network.Protocol.HTTP.DAV.DAVT m)
instance GHC.Internal.Base.Monad m => GHC.Internal.Base.Applicative (Network.Protocol.HTTP.DAV.DAVT m)
instance Data.Default.Internal.Default Network.Protocol.HTTP.DAV.TH.DAVContext
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Functor (Network.Protocol.HTTP.DAV.DAVT m)
instance Control.Monad.Base.MonadBase b m => Control.Monad.Base.MonadBase b (Network.Protocol.HTTP.DAV.DAVT m)
instance Control.Monad.Catch.MonadCatch m => Control.Monad.Catch.MonadCatch (Network.Protocol.HTTP.DAV.DAVT m)
instance GHC.Internal.Base.Monad m => GHC.Internal.Base.Monad (Network.Protocol.HTTP.DAV.DAVT m)
instance GHC.Internal.Base.Monad m => Control.Monad.Error.Class.MonadError GHC.Internal.Base.String (Network.Protocol.HTTP.DAV.DAVT m)
instance GHC.Internal.Control.Monad.Fix.MonadFix m => GHC.Internal.Control.Monad.Fix.MonadFix (Network.Protocol.HTTP.DAV.DAVT m)
instance Control.Monad.IO.Class.MonadIO m => Control.Monad.IO.Class.MonadIO (Network.Protocol.HTTP.DAV.DAVT m)
instance GHC.Internal.Base.Monad m => GHC.Internal.Base.MonadPlus (Network.Protocol.HTTP.DAV.DAVT m)
instance GHC.Internal.Base.Monad m => Control.Monad.State.Class.MonadState Network.Protocol.HTTP.DAV.TH.DAVContext (Network.Protocol.HTTP.DAV.DAVT m)
instance Control.Monad.Catch.MonadThrow m => Control.Monad.Catch.MonadThrow (Network.Protocol.HTTP.DAV.DAVT m)
instance Control.Monad.Trans.Class.MonadTrans Network.Protocol.HTTP.DAV.DAVT
