finch_gleam - v1.0.0

finch/otp

Types related to OTP usage of Finch.

Types

InstanceOption

</> 
pub type InstanceOption {
  Name(Atom)
  Pools(Map(PoolSpecifier, PoolOptions))
}

Constructors 

  • Name(Atom)
  • Pools(Map(PoolSpecifier, PoolOptions))

InstanceOptions

</> 
pub type InstanceOptions =
  List(InstanceOption)

OnStart

</>

Returned by start_link/2.

Note that this is not the same as Gleam’s standard Result type! You will need to match this manually, it cannot be used with try syntax.

pub type OnStart {
  Ok(child: Pid)
  Ignore
  Error(Dynamic)
}

Constructors 

  • Ok(child: Pid)
  • Ignore
  • Error(Dynamic)

PoolOption

</> 
pub type PoolOption {
  Protocol(PoolProtocol)
  Size(Int)
  Count(Int)
  MaxIdleTime(Timeout)
  ConnOpts(List(#(Atom, Dynamic)))
  PoolMaxIdleTime(Timeout)
  ConnMaxIdleTime(Timeout)
}

Constructors 

  • Protocol(PoolProtocol)
  • Size(Int)
  • Count(Int)
  • MaxIdleTime(Timeout)
  • ConnOpts(List(#(Atom, Dynamic)))
  • PoolMaxIdleTime(Timeout)
  • ConnMaxIdleTime(Timeout)

PoolOptions

</> 
pub type PoolOptions =
  List(PoolOption)

PoolProtocol

</> 
pub type PoolProtocol {
  Http1
  Http2
}

Constructors 

  • Http1
  • Http2

PoolSpecifier

</> 
pub type PoolSpecifier {
  Default
  URL(url: uri.Uri)
  UnixSocket(specifier: UnixSocketSpecifier)
}

Constructors 

  • Default
  • URL(url: uri.Uri)
  • UnixSocket(specifier: UnixSocketSpecifier)

UnixSocketPath

</> 
pub type UnixSocketPath {
  Local(path: String)
}

Constructors 

  • Local(path: String)

UnixSocketSpecifier

</> 
pub type UnixSocketSpecifier {
  Http(path: UnixSocketPath)
  Https(path: UnixSocketPath)
}

Constructors 

  • Http(path: UnixSocketPath)
  • Https(path: UnixSocketPath)
✨ Search Document