Struct Continuation 

pub struct Continuation {
    pub branch: String,
    pub version: Version,
    pub resume: Resume,
    pub now: Box<RawValue>,
    /* private fields */
}

Fields

branch: String

version: Version

resume: Resume

now: Box<RawValue>

Later pages use this value; only the first page reads the clock.

Implementations

impl Continuation

pub fn new( branch: String, version: Version, resume: Resume, now: Box<RawValue>, binding: Binding, ) -> Result<Self, Failure>

Construct and validate a captured query continuation.

Errors

Returns query_continuation_invalid for an invalid branch, cursor or score, or propagates an invalid binding.

pub fn encode(&self, seal: &Seal) -> Result<String, Failure>

The token sealed by seal: nothing in it can be read or changed by whoever holds it.

Errors

As Self::plain, and when the token cannot be sealed.

pub fn decode(encoded: &str, seal: &Seal) -> Result<Self, Failure>

The token opened by seal, then checked as Self::from_plain.

Errors

query_continuation_invalid for a token seal did not seal or that was altered; then every refusal of Self::from_plain.

pub fn plain(&self) -> Result<Vec<u8>, Failure>

The token’s own canonical bytes, before sealing.

Errors

When the token is not valid.

pub fn from_plain(bytes: &[u8]) -> Result<Self, Failure>

The token whose canonical bytes are bytes, opened and not yet checked against a request.

Errors

query_continuation_format for another format, and query_continuation_invalid for bytes that are not a valid token in their canonical form.

pub fn check_binding(&self, expected: &Binding) -> Result<(), Failure>

Check the continuation against the next page’s request binding.

Errors

Propagates invalid or changed binding component refusals.

pub fn check_moment( &self, branch: &str, version: Option<Version>, ) -> Result<(), Failure>

Check the requested branch and optional version against the captured moment.

Errors

Returns query_continuation_moment if either differs from the token.

Trait Implementations

impl Debug for Continuation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.