midas - v3.0.0

midas/effect

The effect module defines signatures for standard side effects.

Types

Bundle

</>

Function accepts a module and function and returns bundled code.

Fallible as code might fail compilation

pub type Bundle(t) =
  fn(String, String) -> fn(fn(Result(String, String)) -> t) -> t

ExportJsonWebKey

</>

A function to export key material as JSON

All keys have a valid JSON encoding

pub type ExportJsonWebKey(t, key) =
  fn(key) -> fn(fn(json.Json) -> t) -> t

Fetch

</> 
pub type Fetch(t) =
  fn(request.Request(BitArray)) -> fn(
    fn(Result(response.Response(BitArray), FetchError)) -> t,
  ) -> t

FetchError

</> 
pub type FetchError {
  NetworkError(String)
  UnableToReadBody
  NotImplemented
}

Constructors 

  • NetworkError(String)
  • UnableToReadBody
  • NotImplemented

Follow

</>

Uri might not exist or resolve

pub type Follow(t) =
  fn(uri.Uri) -> fn(fn(Result(uri.Uri, String)) -> t) -> t

GenerateKeypair

</>

algorithm, extractable, uses may fail if uses does not match algorithm

pub type GenerateKeypair(t, key) =
  fn(KeyPairAlgorithm, Bool, List(KeyUsage)) -> fn(
    fn(Result(KeyPair(key), String)) -> t,
  ) -> t

Hash

</> 
pub type Hash(t) =
  fn(HashAlgorithm, BitArray) -> fn(fn(BitArray) -> t) -> t

HashAlgorithm

</>

platform agnostic copy of the type in gleam_crypto.

pub type HashAlgorithm {
  Sha1
  Sha256
  Sha384
  Sha512
}

Constructors 

  • Sha1
  • Sha256
  • Sha384
  • Sha512

KeyPair

</> 
pub type KeyPair(key) {
  KeyPair(public: key, private: key)
}

Constructors 

  • KeyPair(public: key, private: key)

KeyPairAlgorithm

</> 
pub type KeyPairAlgorithm {
  EcKeyGenParams(name: String, named_curve: String)
}

Constructors 

  • EcKeyGenParams(name: String, named_curve: String)

KeyUsage

</> 
pub type KeyUsage {
  CanEncrypt
  CanDecrypt
  CanSign
  CanVerify
  CanDeriveKey
  CanDeriveBits
  CanWrapKey
  CanUnwrapKey
}

Constructors 

  • CanEncrypt
  • CanDecrypt
  • CanSign
  • CanVerify
  • CanDeriveKey
  • CanDeriveBits
  • CanWrapKey
  • CanUnwrapKey

Log

</>

May fail for non existant directory or file system permissions.

pub type Log(t) =
  fn(String) -> fn(fn(Nil) -> t) -> t

ReadDirectory

</>

May fail for non existant directory or file system permissions.

pub type ReadDirectory(t) =
  fn(String) -> fn(fn(Result(List(String), String)) -> t) -> t

ReadFile

</> 
pub type ReadFile(t) =
  fn(String) -> fn(fn(Result(BitArray, String)) -> t) -> t

Serve

</>

can fail if no port available.

pub type Serve(t) =
  fn(
    option.Option(Int),
    fn(request.Request(BitArray)) -> response.Response(BitArray),
  ) -> fn(fn(Result(Int, String)) -> t) -> t

Sign

</> 
pub type Sign(t, key) =
  fn(SignAlgorithm, key, BitArray) -> fn(
    fn(Result(BitArray, String)) -> t,
  ) -> t

SignAlgorithm

</> 
pub type SignAlgorithm {
  EcdsaParams(hash: HashAlgorithm)
}

Constructors

StrongRandom

</>

Does not fail if configured

pub type StrongRandom(t) =
  fn(Int) -> fn(fn(BitArray) -> t) -> t

UnixNow

</> 
pub type UnixNow(t) =
  fn() -> fn(fn(Int) -> t) -> t

Visit

</>

Uri might not exist or resolve

pub type Visit(t) =
  fn(uri.Uri) -> fn(fn(Result(Nil, String)) -> t) -> t

WriteFile

</>

Can fail on permissions

pub type WriteFile(t) =
  fn(String) -> fn(fn(Result(Nil, String)) -> t) -> t

Zip

</>

Uri might not exist or resolve

pub type Zip(t) =
  fn(List(#(String, BitArray))) -> fn(
    fn(Result(BitArray, String)) -> t,
  ) -> t

Values

describe_fetch_error

</> 
pub fn describe_fetch_error(reason: FetchError) -> String
✨ Search Document