cardano-api-1.22.1
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.TextView

Synopsis

"TextView" format

data TextView Source #

A TextView is a structured envelope for serialised binary values with an external format with a semi-readable textual format.

It contains a "type" field, e.g. "PublicKeyByron" or "TxSignedShelley" to indicate the type of the encoded data. This is used as a sanity check and to help readers.

It also contains a "title" field which is free-form, and could be used to indicate the role or purpose to a reader.

data TextViewError Source #

The errors that the pure TextView parsing/decoding functions can return.

Instances

Instances details
Eq TextViewError Source # 
Instance details

Defined in Cardano.Api.TextView

Show TextViewError Source # 
Instance details

Defined in Cardano.Api.TextView

Error TextViewError Source # 
Instance details

Defined in Cardano.Api.Typed

expectTextViewOfType :: TextViewType -> TextView -> Either TextViewError () Source #

Check that the "type" of the TextView is as expected.

For example, one might check that the type is "TxSignedShelley".

textShow :: Show a => a -> Text Source #

File IO support

data TextViewFileError Source #

The errors that the IO TextView reading/decoding actions can return.