Skip to main content

Request

Struct Request 

Source
pub struct Request {
    pub method: Method,
    pub upsert: bool,
    pub path: Vec<String>,
    pub auth: Option<Auth>,
    pub time: Timestamp,
    pub resource: Option<Document>,
    pub query: Option<Query>,
    pub in_transaction: bool,
    pub write_fields: Option<Vec<String>>,
    pub transforms: Option<Vec<String>>,
    pub auto_id: bool,
}
Expand description

One request, as rules see it.

Fields§

§method: Method§upsert: bool

A create or an update without an existence precondition (a set, a patch, a transform): whether the document exists chose the method. A denial then also lists the statements of the other of the two, which cannot allow the write (tools/oracle/rules_writes.py, rules_denials.py).

§path: Vec<String>

The path checked, from databases (a document, or for a list its collection).

§auth: Option<Auth>§time: Timestamp§resource: Option<Document>

The document as it would be after a create or an update; None otherwise.

§query: Option<Query>§in_transaction: bool

request.inTransaction: true for every write, which the official emulator commits in a transaction of its own, and for a read of documents in a transaction begun before it; false for a read that begins one, and for every list, in a transaction or not (tools/oracle/rules_request_fields.py).

§write_fields: Option<Vec<String>>

For a write, request.writeFields: the paths of its transforms, then those of its update mask (None, null, for a write with neither).

§transforms: Option<Vec<String>>

For a write, request.transforms: the paths its field transforms change, in order (None, null, without any).

§auto_id: bool

A create whose document ID the server chooses (a CreateDocument without one). The official emulator decides it without the ID: Request::path is the collection’s, the statements are those of the collection’s documents, with the document’s wildcard unbound, and request.resource holds only data. request.autoId says so for a create that is not an upsert; other writes do not have it.

Trait Implementations§

Source§

impl Clone for Request

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Request

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Request

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Request

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.