Skip to main content

DbFieldsResource

Struct DbFieldsResource 

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

client.db_fields()

Implementations§

Source§

impl<'a> DbFieldsResource<'a>

Source

pub fn options(&self) -> DbFieldsOptionsResource<'a>

Source

pub fn create(&self, body: &DbFieldCreate) -> Result<DbField>

Create a database field

POST /dbfields

Creates an installation-specific field definition and database column. Selection types also create an option table with one initial choice. Checkbox fields are non-nullable and cannot be cleared on archive.

§Example
let body = models::DbFieldCreate {
    delete_on_archive: true,
    is_active: true,
    is_new_person_field: true,
    name: "Dietary notes".into(),
    security_level: 1,
    sort_key: 50,
    use_as_placeholder: false,
    field_category_intern_code: "f_address".into(),
    ..Default::default()
};
let result = client.db_fields().create(&body)?;
println!("{}", result.name);
Source

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

Delete a database field

DELETE /dbfields/{fieldId}

Deletes a field definition, its physical database column and all values stored in that column; also removes its group-person-field mappings and custom selection table if present. Protected built-in fields cause a conflict.

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

pub fn get(&self, field_id: impl Display) -> Result<DbField>

Get a database-field definition

GET /dbfields/{fieldId}

Returns one database-field definition, including its type, category and API key.

§Example
let db_field = client.db_fields().get(200)?;
println!("{}", db_field.name);
Source

pub fn list(&self) -> Result<Vec<DbField>>

List database-field definitions

GET /dbfields

Lists built-in and custom field definitions, not the values stored on individual persons or groups. Use categories[] to restrict the result and include[]=options to expand available choices.

Use Self::list_with to pass query parameters.

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

pub fn list_with(&self, query: &GetDbfieldsQuery) -> Result<Vec<DbField>>

List database-field definitions

Like Self::list, with query parameters.

GET /dbfields

Lists built-in and custom field definitions, not the values stored on individual persons or groups. Use categories[] to restrict the result and include[]=options to expand available choices.

Source

pub fn update( &self, field_id: impl Display, body: &DbFieldUpdate, ) -> Result<DbField>

Update a database field

PUT /dbfields/{fieldId}

Updates a database-field definition. The existing field determines its type. Installation-created person fields can move between f_address, f_church, f_category and f_datasecurity.

§Example
let body = models::DbFieldUpdate {
    delete_on_archive: true,
    is_new_person_field: true,
    security_level: 1,
    sort_key: 50,
    use_as_placeholder: false,
    ..Default::default()
};
let result = client.db_fields().update(200, &body)?;
println!("{}", result.name);

Trait Implementations§

Source§

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

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for DbFieldsResource<'a>

§

impl<'a> !UnwindSafe for DbFieldsResource<'a>

§

impl<'a> Freeze for DbFieldsResource<'a>

§

impl<'a> Send for DbFieldsResource<'a>

§

impl<'a> Sync for DbFieldsResource<'a>

§

impl<'a> Unpin for DbFieldsResource<'a>

§

impl<'a> UnsafeUnpin for DbFieldsResource<'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> 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