Skip to main content

DbFieldsOptionsResource

Struct DbFieldsOptionsResource 

Source
pub struct DbFieldsOptionsResource<'a> { /* private fields */ }
Expand description

client.db_fields().options()

Implementations§

Source§

impl<'a> DbFieldsOptionsResource<'a>

Source

pub fn create( &self, field_id: impl Display, body: &DbFieldOptionCreate, ) -> Result<DbFieldOption>

Create a database-field option

POST /dbfields/{fieldId}/options

Creates an option in the selected field’s backing table. Use the metadata endpoint to determine the complete request shape. Fields without a backing table do not support this operation.

§Example
let body = models::DbFieldOptionCreate {
    name: Some("Vegetarian".into()),
    ..Default::default()
};
let result = client.db_fields().options().create(200, &body)?;
println!("{:?}", result.name);
Source

pub fn delete( &self, field_id: impl Display, option_id: impl Display, ) -> Result<()>

Delete a database-field option

DELETE /dbfields/{fieldId}/options/{optionId}

Deletes an option row from the selected field’s backing masterdata table through the shared deletion service. References can block deletion. dryRun=true returns the deletion preview with HTTP 409 without removing the row.

Use Self::delete_with to pass query parameters.

§Example
client.db_fields().options().delete(200, 3)?;
Source

pub fn delete_with( &self, field_id: impl Display, option_id: impl Display, query: &DeleteDbfieldsFieldIdOptionsOptionIdQuery, ) -> Result<()>

Delete a database-field option

Like Self::delete, with query parameters.

DELETE /dbfields/{fieldId}/options/{optionId}

Deletes an option row from the selected field’s backing masterdata table through the shared deletion service. References can block deletion. dryRun=true returns the deletion preview with HTTP 409 without removing the row.

Source

pub fn list(&self, field_id: impl Display) -> Result<Vec<DbFieldOption>>

List options for a database field

GET /dbfields/{fieldId}/options

Lists option rows from the field’s backing masterdata table. Rows are ordered by sortKey when available. Fields without a backing table return an empty list. Read the option metadata to interpret row keys.

§Example
for option in client.db_fields().options().list(200)? {
    println!("{:?}", option.name);
}
Source

pub fn list_metadata( &self, field_id: impl Display, ) -> Result<Vec<DbFieldOptionColumn>>

Get metadata for field options

GET /dbfields/{fieldId}/options/metadata

Describes the actual SQL columns of the selected field’s backing option table as API properties. Audit columns are omitted. Use this operation only for fields backed by a table.

§Example
for metadata in client.db_fields().options().list_metadata(200)? {
    println!("{}", metadata.name);
}
Source

pub fn update( &self, field_id: impl Display, option_id: impl Display, body: &DbFieldOptionUpdate, ) -> Result<DbFieldOption>

Update a database-field option

PUT /dbfields/{fieldId}/options/{optionId}

Updates an option row using all non-auto-increment columns from the metadata endpoint. This operation replaces the complete metadata-defined row and supports only fields backed by a table.

§Example
let body = models::DbFieldOptionUpdate {
    name: Some("Vegetarian".into()),
    ..Default::default()
};
let result = client.db_fields().options().update(200, 3, &body)?;
println!("{:?}", result.name);

Trait Implementations§

Source§

impl<'a> Clone for DbFieldsOptionsResource<'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 DbFieldsOptionsResource<'a>

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> 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> PolicyExt for T
where T: ?Sized,

Source§

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
Source§

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
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