Struct ReadRequest 

#[non_exhaustive]
pub struct ReadRequest {
    pub after: Option<Cursor>,
    pub limit: Option<u32>,
    pub harness: Option<String>,
    pub session: Option<String>,
}

Request of usage.steps.read. Both members are optional and also accept null; any other member is refused malformed, and so does this type.

Without after, the read starts at the oldest row the feed still holds (the rows committed in the last 24 hours). limit defaults to 200; 0 is refused invalid_request and above 1,000 range_too_large. This type does not check limit: the provider does.

harness and session narrow the read to one session’s rows. Without after, such a read also starts at the oldest row the feed holds. They come together or not at all: this type accepts either alone, and the provider refuses one alone invalid_request, as it refuses a bad limit. See ReadRequest::check_pairing.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

after: Option<Cursor>

limit: Option<u32>

harness: Option<String>

The producer to read rows of; see StepRow::harness.

session: Option<String>

The session to read rows of, matched exactly.

Implementations

impl ReadRequest

pub fn new() -> Self

A read from the oldest row the feed holds, with the default limit.

pub fn after(self, cursor: impl Into<Cursor>) -> Self

Reads the rows after cursor.

pub fn with_limit(self, limit: u32) -> Self

Asks for at most limit rows.

pub fn for_session( self, harness: impl Into<String>, session: impl Into<String>, ) -> Self

Reads only the rows whose harness and session are these.

pub fn check_pairing(&self) -> Result<(), &'static str>

Reports a request naming only one of harness and session. The pair comes together or not at all; the provider refuses a request that names one alone invalid_request. Both together and neither are fine.

Trait Implementations

impl Clone for ReadRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadRequest

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

Formats the value using the given formatter.

impl Default for ReadRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReadRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReadRequest

impl PartialEq for ReadRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ReadRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReadRequest