Cachix.Client.Push

Pushing a single path

pushSingleStorePath

Arguments

:: (MonadMask m, MonadIO m)

=> PushParams m r

details for pushing to cache

-> StorePath

store path

-> m r

r is determined by the PushStrategy

uploadStorePath

Arguments

:: (MonadMask m, MonadIO m)

=> PushParams m r

details for pushing to cache

-> StorePath

-> RetryStatus

-> m r

r is determined by the PushStrategy

data PushParams m r

Constructors

PushParams

Fields

• pushParamsName :: Text
• pushParamsSecret :: PushSecret
• pushParamsStrategy :: StorePath -> PushStrategy m r

  how to report results, (some) errors, and do some things

• pushParamsClientEnv :: ClientEnv

  cachix base url, connection manager, see defaultCachixBaseUrl, mkClientEnv

• pushParamsStore :: Store

data PushSecret

Constructors

PushToken Token

PushSigningKey Token SigningKey

data PushStrategy m r

Constructors

PushStrategy

Fields

• onAlreadyPresent :: m r

  Called when a path is already in the cache.

• onAttempt :: RetryStatus -> Int64 -> m ()
• on401 :: m r
• onError :: ClientError -> m r
• onDone :: m r
• withXzipCompressor :: forall a. (ConduitM ByteString ByteString (ResourceT IO) () -> m a) -> m a
• omitDeriver :: Bool

defaultWithXzipCompressor :: forall m a. (ConduitM ByteString ByteString (ResourceT IO) () -> m a) -> m a

defaultWithXzipCompressorWithLevel :: Int -> forall m a. (ConduitM ByteString ByteString (ResourceT IO) () -> m a) -> m a

findPushSecret

Arguments

:: Maybe Config

-> Text

Cache name

-> IO PushSecret

Secret key or exception

Find auth token or signing key in the Config or environment variable

Pushing a closure of store paths

pushClosure

Arguments

:: (MonadIO m, MonadMask m)

=> (forall a b. (a -> m b) -> [a] -> m [b])

Traverse paths, responsible for bounding parallel processing of paths

For example: mapConcurrentlyBounded 4

-> PushParams m r

-> [StorePath]

Initial store paths

-> m [r]

Every r per store path of the entire closure of store paths

Push an entire closure

Note: onAlreadyPresent will be called less often in the future.

getMissingPathsForClosure :: (MonadIO m, MonadMask m) => PushParams m r -> [StorePath] -> m [StorePath]

mapConcurrentlyBounded :: Traversable t => Int -> (a -> IO b) -> t a -> IO (t b)