gossamer - v9.2.0

gossamer/headers

Types

Headers

</>

An HTTP header set used with fetch, Request, and Response. Headers are mutable — methods like append, delete, and set modify the set in place.

See Headers on MDN.

pub type Headers

Values

append

</> 
pub fn append(
  to headers: Headers,
  name name: String,
  value value: String,
) -> Result(Headers, js_error.JsError)

Appends a new value onto an existing header, or adds the header if it does not already exist. Mutates the headers in-place and returns them for chaining. Returns an error if the name or value is not a valid ByteString.

delete

</> 
pub fn delete(
  from headers: Headers,
  name name: String,
) -> Result(Headers, js_error.JsError)

Deletes a header. Mutates the headers in-place and returns them for chaining. Returns an error if the name is not a valid ByteString.

entries

</> 
pub fn entries(
  of headers: Headers,
) -> iterator.Iterator(#(String, String), Nil, Nil)

for_each

</> 
pub fn for_each(
  in headers: Headers,
  run callback: fn(String, String) -> a,
) -> Nil

from_pairs

</> 
pub fn from_pairs(
  pairs: List(#(String, String)),
) -> Result(Headers, js_error.JsError)

Creates a Headers object from a list of name/value pairs. Returns an error if any name or value is not a valid ByteString.

get

</> 
pub fn get(
  from headers: Headers,
  name name: String,
) -> Result(option.Option(String), js_error.JsError)

Returns the value for name, combining multiple values with , . Ok(None) if no such header exists. Returns an error if name is not a valid ByteString.

</> 
pub fn get_set_cookie(from headers: Headers) -> List(String)

Returns the values of all Set-Cookie headers separately (rather than combining them with , like get would).

has

</> 
pub fn has(
  in headers: Headers,
  name name: String,
) -> Result(Bool, js_error.JsError)

Checks whether a header with name exists. Returns an error if name is not a valid ByteString.

keys

</> 
pub fn keys(
  of headers: Headers,
) -> iterator.Iterator(String, Nil, Nil)

new

</> 
pub fn new() -> Headers

set

</> 
pub fn set(
  in headers: Headers,
  name name: String,
  value value: String,
) -> Result(Headers, js_error.JsError)

Sets a new value for an existing header, or adds the header if it does not already exist. Mutates the headers in-place and returns them for chaining. Returns an error if the name or value is not a valid ByteString.

values

</> 
pub fn values(
  of headers: Headers,
) -> iterator.Iterator(String, Nil, Nil)
✨ Search Document