moonbitstack/moonhttp/conditional

moonbitstack/moonhttp/conditional does not have a README file

Ask

pub(all) struct Ask {
  matching : Tags?
  none_matching : Tags?
  modified_since : @moonbitstack/moondate.Moment
Moment?
  unmodified_since : @moonbitstack/moondate.Moment
Moment?
  ranging : Validator?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The five precondition fields of one request (§13.1), already read.

Ask::equal

source

fn Ask::equal(Ask, Ask) -> Bool

Ask::evaluate

source

fn Ask::evaluate(self : Ask, verb~ : String, etag? : Tag, modified? : @moonbitstack/moondate.Moment
Moment, present? : Bool) -> Verdict

Weigh the preconditions in the order §13.2.2 sets out.

verb is the request method (method is reserved). It decides what a failed If-None-Match means: 304 for a GET or HEAD, 412 otherwise. No default — guessing GET would tell a PUT its copy is current.

etag and modified are what the server holds; present is whether it holds anything at all, which is all * asks.

Ask::new

source

fn Ask::new(matching? : Tags, none_matching? : Tags, modified_since? : @moonbitstack/moondate.Moment
Moment, unmodified_since? : @moonbitstack/moondate.Moment
Moment, ranging? : Validator) -> Ask

The preconditions a request carried, named one at a time.

Ask::not_equal

source

fn Ask::not_equal(x : Ask, y : Ask) -> Bool

Ask::read

source

fn Ask::read(headers : ArrayView[(String, String)]) -> Ask

Pull the five fields out of a request's headers.

Names match without regard to case (§5.1). Two lines of one list-valued field are one list (§5.3), so the tag fields are joined before reading; the date fields are not lists, so a repeat is ignored.

A field present but unreadable comes back absent, per §13.1.3 and §13.1.4.

Ask::to_repr

source

fn Ask::to_repr(Ask) -> @moonbitlang/core/debug.Repr
Repr

Ask::unchanged

source

fn Ask::unchanged(self : Ask, etag? : Tag, modified? : @moonbitstack/moondate.Moment
Moment) -> Bool

Whether If-Range still holds, and so whether a Range may be honoured (§13.1.5). Absent holds: no condition, nothing in the way.

Both kinds compare strongly, and a weak tag is refused rather than compared — "may these octets be spliced onto yours" is what a weak tag may not answer.

Tag

source

pub(all) struct Tag {
  text : String
  weak : Bool
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An entity-tag (RFC 9110 §8.8.3).

text is what is inside the quotes; keeping them would put the field's syntax inside the value.

weak is the W/ in front. Two weak tags mark representations that are equivalent, not identical — enough for "has this changed", not enough for "may I splice these two ranges".

Tag::alike

source

fn Tag::alike(self : Tag, other : Tag) -> Bool

Weak comparison (§8.8.3.2): the texts match, weakness ignored.

If-None-Match uses this one — a weak tag can answer "has it changed".

Tag::decode

source

fn Tag::decode(text : StringView) -> Tag?

Read one entity-tag. None when it is not one — usually an unquoted value, which §8.8.3 has no room for.

Tag::encode

source

fn Tag::encode(self : Tag) -> String

Write the tag as a field value: "x", or W/"x" (§8.8.3).

Tag::equal

source

fn Tag::equal(Tag, Tag) -> Bool

Tag::new

source

fn Tag::new(text : String, weak? : Bool) -> Tag

A tag with this text.

Tag::not_equal

source

fn Tag::not_equal(x : Tag, y : Tag) -> Bool

Tag::same

source

fn Tag::same(self : Tag, other : Tag) -> Bool

Strong comparison (§8.8.3.2): neither is weak and the texts match.

If-Match and If-Range use this one — both are about replacing or splicing octets, which a weak tag does not promise.

Tag::to_repr

source

fn Tag::to_repr(Tag) -> @moonbitlang/core/debug.Repr
Repr

Tags::decode

source

fn Tags::decode(text : StringView) -> Tags?

Read a whole field value.

Commas are found outside the quotes: , is in the etagc set (§8.8.3), so a tag may contain one. None when any member is not an entity-tag — §13.1.1 has no reading for half a list.

Tags::encode

source

fn Tags::encode(self : Tags) -> String

Write a whole field value: *, or the tags separated by commas.

Tags::equal

source

fn Tags::equal(Tags, Tags) -> Bool

Tags::not_equal

source

fn Tags::not_equal(x : Tags, y : Tags) -> Bool

Tags::to_repr

source

fn Tags::to_repr(Tags) -> @moonbitlang/core/debug.Repr
Repr

Validator

source

pub(all) enum Validator {
  Marked(Tag)
  Dated(@moonbitstack/moondate.Moment
Moment)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Either kind of validator (§8.8). If-Range takes one or the other (§13.1.5); the other four fields each take one kind.

Validator::decode

source

fn Validator::decode(text : StringView) -> Validator?

Read an If-Range value (§13.1.5).

The first two characters tell them apart, as §13.1.5 says: only an entity-tag starts with a quote, only a weak one with W/.

Validator::encode

source

fn Validator::encode(self : Validator) -> String raise @moonbitstack/moondate.Refused
Refused

Write an If-Range value. Raises for a moment with no zone — an HTTP-date is GMT by definition (§5.6.7).

Validator::equal

source

fn Validator::equal(Validator, Validator) -> Bool

Validator::not_equal

source

fn Validator::not_equal(x : Validator, y : Validator) -> Bool

Validator::to_repr

source

fn Validator::to_repr(Validator) -> @moonbitlang/core/debug.Repr
Repr

Verdict

source

pub(all) enum Verdict {
  Go
  Fresh
  Failed
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What §13.2.2 says to do with the request once the preconditions are weighed.

Verdict::equal

source

fn Verdict::equal(Verdict, Verdict) -> Bool

Verdict::not_equal

source

fn Verdict::not_equal(x : Verdict, y : Verdict) -> Bool

Verdict::to_repr

source

fn Verdict::to_repr(Verdict) -> @moonbitlang/core/debug.Repr
Repr

ask

source

let ask : Ask

A request that carried no preconditions at all.

hash

source

fn hash(raw : BytesView, digest~ : &@moonbitstack/mooncrypt/spec.Hash
Hash, weak? : Bool) -> Tag

An entity-tag from the octets themselves: their count and their digest, both in hexadecimal. Strong, which is the point of hashing the content.

digest is a parameter — which hash to spend on every response is the server's trade. The shape is the etag package Express serves static files with, "<length>-<digest>", in nginx and Apache's hexadecimal.

stamp

source

fn stamp(length~ : Int64, modified~ : @moonbitstack/moondate.Moment
Moment, weak? : Bool) -> Tag

An entity-tag from what a file system knows without opening the file: when it last changed and how long it is. nginx's "<mtime>-<length>", one stat.

Weak, as a one-second timestamp must be: two writes inside the same second leave both numbers unchanged.

Source Files

conditional.mbt

Install

Download zip

moonhttp — the HTTP family for MoonBit: URI references and percent coding, conditional requests and entity-tags, range requests, HTTP/1.1, HTTP/2 and HTTP/3 framing, HPACK and QPACK header compression, WebSocket framing and its handshake, Server-Sent Events, cookies, data URLs, multipart bodies and media types, each a package of its own. Bytes in, events out; no sockets.

httpurletaghttp3websockethpackqpackprotocolmoonbit

moonbitstack

Apache-2.0

github.com/moonbitstack/moonhttp

Updated 2 hours ago

305 downloads

Dependencies

Site source Report issue Packages Build queue Skills Statistics

#Ask

#Ask::equal

#Ask::evaluate

#Ask::new

#Ask::not_equal

#Ask::read

#Ask::to_repr

#Ask::unchanged

#Tag

#Tag::alike

#Tag::decode

#Tag::encode

#Tag::equal

#Tag::new

#Tag::not_equal

#Tag::same

#Tag::to_repr

#Tags

#Tags::decode

#Tags::encode

#Tags::equal

#Tags::not_equal

#Tags::to_repr

#Validator

#Validator::decode

#Validator::encode

#Validator::equal

#Validator::not_equal

#Validator::to_repr

#Verdict

#Verdict::equal

#Verdict::not_equal

#Verdict::to_repr

#ask

#hash

#stamp

Source Files

Ask

Ask::equal

Ask::evaluate

Ask::new

Ask::not_equal

Ask::read

Ask::to_repr

Ask::unchanged

Tag

Tag::alike

Tag::decode

Tag::encode

Tag::equal

Tag::new

Tag::not_equal

Tag::same

Tag::to_repr

Tags

Tags::decode

Tags::encode

Tags::equal

Tags::not_equal

Tags::to_repr

Validator

Validator::decode

Validator::encode

Validator::equal

Validator::not_equal

Validator::to_repr

Verdict

Verdict::equal

Verdict::not_equal

Verdict::to_repr

ask

hash

stamp