Safe Haskell	None
Language	Haskell98

Mismi.S3.Core.Data

Synopsis

data WriteMode
- = Fail
- | Overwrite
data SyncMode
- = FailSync
- | OverwriteSync
- | SkipSync
newtype Bucket = Bucket {
- unBucket :: Text
}
data Address = Address {
- bucket :: !Bucket
- key :: !Key
}
newtype Key = Key {
- unKey :: Text
}
newtype ReadGrant = ReadGrant {
- readGrant :: Text
}
data WriteResult
- = WriteOk
- | WriteDestinationExists !Address
newtype Bytes = Bytes {
- unBytes :: Int64
}
data Sized a = Sized {
- sizedBytes :: !Bytes
- sizedValue :: !a
}
(//) :: Key -> Key -> Key
combineKey :: Key -> Key -> Key
dirname :: Key -> Key
foldWriteMode :: a -> a -> WriteMode -> a
foldSyncMode :: a -> a -> a -> SyncMode -> a
basename :: Key -> Maybe Text
addressFromText :: Text -> Maybe Address
addressToText :: Address -> Text
removeCommonPrefix :: Address -> Address -> Maybe Key
withKey :: (Key -> Key) -> Address -> Address
s3Parser :: Parser Address

Documentation

data WriteMode Source #

Describes the semantics for destructive operation that may result in overwritten files.

Constructors

Fail	Fail rather than overwrite any data.
Overwrite	Overwrite existing data silently, i.e. we really want to do this.

Instances

Eq WriteMode Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: WriteMode -> WriteMode -> Bool # (/=) :: WriteMode -> WriteMode -> Bool #
Show WriteMode Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> WriteMode -> ShowS # show :: WriteMode -> String # showList :: [WriteMode] -> ShowS #

data SyncMode Source #

Constructors

FailSync
OverwriteSync
SkipSync

Instances

Eq SyncMode Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: SyncMode -> SyncMode -> Bool # (/=) :: SyncMode -> SyncMode -> Bool #
Show SyncMode Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> SyncMode -> ShowS # show :: SyncMode -> String # showList :: [SyncMode] -> ShowS #

newtype Bucket Source #

Constructors

Bucket
Fields unBucket :: Text

Instances

Eq Bucket Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: Bucket -> Bucket -> Bool # (/=) :: Bucket -> Bucket -> Bool #
Data Bucket Source #
Instance details Defined in Mismi.S3.Core.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Bucket -> c Bucket # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Bucket # toConstr :: Bucket -> Constr # dataTypeOf :: Bucket -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Bucket) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Bucket) # gmapT :: (forall b. Data b => b -> b) -> Bucket -> Bucket # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Bucket -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Bucket -> r # gmapQ :: (forall d. Data d => d -> u) -> Bucket -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Bucket -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Bucket -> m Bucket # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Bucket -> m Bucket # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Bucket -> m Bucket #
Ord Bucket Source #
Instance details Defined in Mismi.S3.Core.Data Methods compare :: Bucket -> Bucket -> Ordering # (<) :: Bucket -> Bucket -> Bool # (<=) :: Bucket -> Bucket -> Bool # (>) :: Bucket -> Bucket -> Bool # (>=) :: Bucket -> Bucket -> Bool # max :: Bucket -> Bucket -> Bucket # min :: Bucket -> Bucket -> Bucket #
Show Bucket Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> Bucket -> ShowS # show :: Bucket -> String # showList :: [Bucket] -> ShowS #

data Address Source #

Constructors

Address
Fields bucket :: !Bucket key :: !Key

Instances

Eq Address Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #
Data Address Source #
Instance details Defined in Mismi.S3.Core.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Address -> c Address # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Address # toConstr :: Address -> Constr # dataTypeOf :: Address -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Address) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Address) # gmapT :: (forall b. Data b => b -> b) -> Address -> Address # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Address -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Address -> r # gmapQ :: (forall d. Data d => d -> u) -> Address -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Address -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Address -> m Address # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Address -> m Address # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Address -> m Address #
Ord Address Source #
Instance details Defined in Mismi.S3.Core.Data Methods compare :: Address -> Address -> Ordering # (<) :: Address -> Address -> Bool # (<=) :: Address -> Address -> Bool # (>) :: Address -> Address -> Bool # (>=) :: Address -> Address -> Bool # max :: Address -> Address -> Address # min :: Address -> Address -> Address #
Show Address Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #

newtype Key Source #

Constructors

Key
Fields unKey :: Text

Instances

Eq Key Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Data Key Source #
Instance details Defined in Mismi.S3.Core.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Key -> c Key # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Key # toConstr :: Key -> Constr # dataTypeOf :: Key -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Key) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Key) # gmapT :: (forall b. Data b => b -> b) -> Key -> Key # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r # gmapQ :: (forall d. Data d => d -> u) -> Key -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Key -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Key -> m Key # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key #
Ord Key Source #
Instance details Defined in Mismi.S3.Core.Data Methods compare :: Key -> Key -> Ordering # (<) :: Key -> Key -> Bool # (<=) :: Key -> Key -> Bool # (>) :: Key -> Key -> Bool # (>=) :: Key -> Key -> Bool # max :: Key -> Key -> Key # min :: Key -> Key -> Key #
Show Key Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #

newtype ReadGrant Source #

Constructors

ReadGrant
Fields readGrant :: Text

Instances

Eq ReadGrant Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: ReadGrant -> ReadGrant -> Bool # (/=) :: ReadGrant -> ReadGrant -> Bool #
Show ReadGrant Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> ReadGrant -> ShowS # show :: ReadGrant -> String # showList :: [ReadGrant] -> ShowS #

data WriteResult Source #

Constructors

WriteOk
WriteDestinationExists !Address

Instances

Eq WriteResult Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: WriteResult -> WriteResult -> Bool # (/=) :: WriteResult -> WriteResult -> Bool #
Show WriteResult Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> WriteResult -> ShowS # show :: WriteResult -> String # showList :: [WriteResult] -> ShowS #

newtype Bytes Source #

Constructors

Bytes
Fields unBytes :: Int64

Instances

Enum Bytes Source #
Instance details Defined in Mismi.S3.Core.Data Methods succ :: Bytes -> Bytes # pred :: Bytes -> Bytes # toEnum :: Int -> Bytes # fromEnum :: Bytes -> Int # enumFrom :: Bytes -> [Bytes] # enumFromThen :: Bytes -> Bytes -> [Bytes] # enumFromTo :: Bytes -> Bytes -> [Bytes] # enumFromThenTo :: Bytes -> Bytes -> Bytes -> [Bytes] #
Eq Bytes Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: Bytes -> Bytes -> Bool # (/=) :: Bytes -> Bytes -> Bool #
Integral Bytes Source #
Instance details Defined in Mismi.S3.Core.Data Methods quot :: Bytes -> Bytes -> Bytes # rem :: Bytes -> Bytes -> Bytes # div :: Bytes -> Bytes -> Bytes # mod :: Bytes -> Bytes -> Bytes # quotRem :: Bytes -> Bytes -> (Bytes, Bytes) # divMod :: Bytes -> Bytes -> (Bytes, Bytes) # toInteger :: Bytes -> Integer #
Num Bytes Source #
Instance details Defined in Mismi.S3.Core.Data Methods (+) :: Bytes -> Bytes -> Bytes # (-) :: Bytes -> Bytes -> Bytes # (*) :: Bytes -> Bytes -> Bytes # negate :: Bytes -> Bytes # abs :: Bytes -> Bytes # signum :: Bytes -> Bytes # fromInteger :: Integer -> Bytes #
Ord Bytes Source #
Instance details Defined in Mismi.S3.Core.Data Methods compare :: Bytes -> Bytes -> Ordering # (<) :: Bytes -> Bytes -> Bool # (<=) :: Bytes -> Bytes -> Bool # (>) :: Bytes -> Bytes -> Bool # (>=) :: Bytes -> Bytes -> Bool # max :: Bytes -> Bytes -> Bytes # min :: Bytes -> Bytes -> Bytes #
Real Bytes Source #
Instance details Defined in Mismi.S3.Core.Data Methods toRational :: Bytes -> Rational #
Show Bytes Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> Bytes -> ShowS # show :: Bytes -> String # showList :: [Bytes] -> ShowS #

data Sized a Source #

Constructors

Sized
Fields sizedBytes :: !Bytes sizedValue :: !a

Instances

Functor Sized Source #
Instance details Defined in Mismi.S3.Core.Data Methods fmap :: (a -> b) -> Sized a -> Sized b # (<$) :: a -> Sized b -> Sized a #
Foldable Sized Source #
Instance details Defined in Mismi.S3.Core.Data Methods fold :: Monoid m => Sized m -> m # foldMap :: Monoid m => (a -> m) -> Sized a -> m # foldr :: (a -> b -> b) -> b -> Sized a -> b # foldr' :: (a -> b -> b) -> b -> Sized a -> b # foldl :: (b -> a -> b) -> b -> Sized a -> b # foldl' :: (b -> a -> b) -> b -> Sized a -> b # foldr1 :: (a -> a -> a) -> Sized a -> a # foldl1 :: (a -> a -> a) -> Sized a -> a # toList :: Sized a -> [a] # null :: Sized a -> Bool # length :: Sized a -> Int # elem :: Eq a => a -> Sized a -> Bool # maximum :: Ord a => Sized a -> a # minimum :: Ord a => Sized a -> a # sum :: Num a => Sized a -> a # product :: Num a => Sized a -> a #
Traversable Sized Source #
Instance details Defined in Mismi.S3.Core.Data Methods traverse :: Applicative f => (a -> f b) -> Sized a -> f (Sized b) # sequenceA :: Applicative f => Sized (f a) -> f (Sized a) # mapM :: Monad m => (a -> m b) -> Sized a -> m (Sized b) # sequence :: Monad m => Sized (m a) -> m (Sized a) #
Eq a => Eq (Sized a) Source #
Instance details Defined in Mismi.S3.Core.Data Methods (==) :: Sized a -> Sized a -> Bool # (/=) :: Sized a -> Sized a -> Bool #
Ord a => Ord (Sized a) Source #
Instance details Defined in Mismi.S3.Core.Data Methods compare :: Sized a -> Sized a -> Ordering # (<) :: Sized a -> Sized a -> Bool # (<=) :: Sized a -> Sized a -> Bool # (>) :: Sized a -> Sized a -> Bool # (>=) :: Sized a -> Sized a -> Bool # max :: Sized a -> Sized a -> Sized a # min :: Sized a -> Sized a -> Sized a #
Show a => Show (Sized a) Source #
Instance details Defined in Mismi.S3.Core.Data Methods showsPrec :: Int -> Sized a -> ShowS # show :: Sized a -> String # showList :: [Sized a] -> ShowS #

(//) :: Key -> Key -> Key Source #

combineKey :: Key -> Key -> Key Source #

dirname :: Key -> Key Source #

Get the prefix for a given key (eg. dirname "/foo/bar" == "foo").

foldWriteMode :: a -> a -> WriteMode -> a Source #

foldSyncMode :: a -> a -> a -> SyncMode -> a Source #

basename :: Key -> Maybe Text Source #

Get the basename for a given key (eg. basename "/foo/bar" == "bar"). Return Nothing for the empty Key _and_ when the name ends with a "/".

addressFromText :: Text -> Maybe Address Source #

Parse an Address from Text. If the parse fails, Nothing is returned.

addressToText :: Address -> Text Source #

Render an Address to Text, including the "s3://" prefix.

removeCommonPrefix :: Address -> Address -> Maybe Key Source #

withKey :: (Key -> Key) -> Address -> Address Source #

withKey f address : Replace the Key part of an Address with a new Key resulting from the application of function f to the old Key.

s3Parser :: Parser Address Source #