drasil-assets-0.0.1: A framework for code and document generation for scientific software - Assets SubPackage
Safe HaskellNone
LanguageGHC2024

Drasil.Assets

Description

External file Assets.

Synopsis

Documentation

data Asset Source #

An arbitrary file asset; a ByteString with a description.

Instances

Instances details
Lift Asset Source # 
Instance details

Defined in Drasil.Assets.Core

Methods

lift :: Quote m => Asset -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Asset -> Code m Asset #

mkAsset :: Text -> ByteString -> Asset Source #

content :: Asset -> ByteString Source #

Get the raw ByteString content of an Asset.

description :: Asset -> Text Source #

Get the description of an Asset.

toFile :: Asset -> PathSegment -> FileLayout Source #

Convert an Asset to a FileLayout node given a PathSegment (file name) it is to be written to.

data Asset Source #

An arbitrary file asset; a ByteString with a description.

Instances

Instances details
Lift Asset Source # 
Instance details

Defined in Drasil.Assets.Core

Methods

lift :: Quote m => Asset -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Asset -> Code m Asset #

content :: Asset -> ByteString Source #

Get the raw ByteString content of an Asset.

description :: Asset -> Text Source #

Get the description of an Asset.

toFile :: Asset -> PathSegment -> FileLayout Source #

Convert an Asset to a FileLayout node given a PathSegment (file name) it is to be written to.

readAsset :: OsPath -> Text -> Code Q Asset Source #

Read a file from disk, providing a description of the asset.