Skip to main content

ChangesParams

Struct ChangesParams 

Source
#[non_exhaustive]
pub struct ChangesParams<'a> { pub since_state: &'a State, pub max_changes: Option<u64>, pub ignore_metadata_only_changes: bool, }
Expand description

The /changes arguments (RFC 8620 §5.2) passed to JmapBackend::get_changes, after accountId.

#[non_exhaustive] for the same reason as QueryParams. Build one with ChangesParams::new, which takes the one required argument, sinceState, and the setters:

let since = jmap_server::State::from("s1");
let params = ChangesParams::new(&since).max_changes(Some(50));
assert_eq!(params.max_changes, Some(50));
assert!(!params.ignore_metadata_only_changes);

Fields (Non-exhaustive)§

This struct is marked as 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.
§since_state: &'a State

sinceState, the state the client already has.

§max_changes: Option<u64>

maxChanges; None means no client limit.

§ignore_metadata_only_changes: bool

ignoreMetadataOnlyChanges (draft-ietf-jmap-metadata-04 §3.3): when true, a backend that tracks per-update changed properties MUST leave out of updated every id whose only changes are to metadata and/or privateMetadata, and those ids do not count toward max_changes. crate::handle_changes sets it true for a request whose using lacks urn:ietf:params:jmap:metadata (-04 §3). A backend that does not support metadata ignores it.

Implementations§

Source§

impl<'a> ChangesParams<'a>

Source

pub fn new(since_state: &'a State) -> Self

Changes since since_state, with no maxChanges and ignoreMetadataOnlyChanges false (its -04 §3.3 default).

Source

pub fn max_changes(self, max_changes: Option<u64>) -> Self

Source

pub fn ignore_metadata_only_changes(self, ignore: bool) -> Self

Trait Implementations§

Source§

impl<'a> Clone for ChangesParams<'a>

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<'a> Copy for ChangesParams<'a>

Source§

impl<'a> Debug for ChangesParams<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ChangesParams<'a>

§

impl<'a> RefUnwindSafe for ChangesParams<'a>

§

impl<'a> Send for ChangesParams<'a>

§

impl<'a> Sync for ChangesParams<'a>

§

impl<'a> Unpin for ChangesParams<'a>

§

impl<'a> UnsafeUnpin for ChangesParams<'a>

§

impl<'a> UnwindSafe for ChangesParams<'a>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more