Skip to main content

FirestoreIndexParams

Struct FirestoreIndexParams

pub struct FirestoreIndexParams {
    pub collection_group: FirestoreCollectionId,
    pub composite_indexes: Vec<FirestoreCompositeIndex>,
    pub field_overrides: Vec<FirestoreFieldOverride>,
    pub ttl_fields: Vec<String>,
}

Expand description

One collection group’s declared composite indexes, single-field overrides and TTL policy.

A statement owns exactly this one collection group: FirestoreIndexSyncOptions::prune never reaches an index, override or TTL field on any other group. Several groups need several statements.

Fields§

§collection_group: FirestoreCollectionId

The collection group this statement owns.

§composite_indexes: Vec<FirestoreCompositeIndex>

The declared composite indexes.

§field_overrides: Vec<FirestoreFieldOverride>

The declared single-field index overrides.

§ttl_fields: Vec<String>

The field paths whose timestamp should enable document TTL.

Implementations§

impl FirestoreIndexParams

pub fn new(collection_group: FirestoreCollectionId) -> Self

Creates a new FirestoreIndexParams from its required fields. Option fields start as None, and fields with #[default] take their default.

pub fn collection_group(&mut self, value: FirestoreCollectionId) -> &mut Self

Sets collection_group to value.

The collection group this statement owns.

pub fn with_collection_group(self, value: FirestoreCollectionId) -> Self

Returns self with collection_group set to value.

The collection group this statement owns.

pub fn composite_indexes( &mut self, value: Vec<FirestoreCompositeIndex>, ) -> &mut Self

Sets composite_indexes to value.

The declared composite indexes.

pub fn with_composite_indexes(self, value: Vec<FirestoreCompositeIndex>) -> Self

Returns self with composite_indexes set to value.

The declared composite indexes.

pub fn field_overrides( &mut self, value: Vec<FirestoreFieldOverride>, ) -> &mut Self

Sets field_overrides to value.

The declared single-field index overrides.

pub fn with_field_overrides(self, value: Vec<FirestoreFieldOverride>) -> Self

Returns self with field_overrides set to value.

The declared single-field index overrides.

pub fn ttl_fields(&mut self, value: Vec<String>) -> &mut Self

Sets ttl_fields to value.

The field paths whose timestamp should enable document TTL.

pub fn with_ttl_fields(self, value: Vec<String>) -> Self

Returns self with ttl_fields set to value.

The field paths whose timestamp should enable document TTL.

Trait Implementations§

impl Clone for FirestoreIndexParams

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

impl Debug for FirestoreIndexParams

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

Formats the value using the given formatter. Read more

impl From<FirestoreIndexParamsInit> for FirestoreIndexParams

fn from(value: FirestoreIndexParamsInit) -> Self

Converts to this type from the input type.

impl PartialEq for FirestoreIndexParams

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

impl StructuralPartialEq for FirestoreIndexParams

Auto Trait Implementations§

impl Freeze for FirestoreIndexParams

impl RefUnwindSafe for FirestoreIndexParams

impl Send for FirestoreIndexParams

impl Sync for FirestoreIndexParams

impl Unpin for FirestoreIndexParams

impl UnsafeUnpin for FirestoreIndexParams

impl UnwindSafe for FirestoreIndexParams

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

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

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

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

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

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

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