Skip to main content

DbField

Struct DbField 

Source
pub struct DbField {
Show 27 fields pub delete_on_archive: bool, pub is_active: bool, pub is_available_in_routines: bool, pub is_new_person_field: bool, pub length: Option<i64>, pub line_ending: Option<String>, pub name: String, pub security_level: i64, pub shorty: Option<String>, pub sort_key: i64, pub use_as_placeholder: bool, pub deprecated: DbFieldDeprecated, pub column: Option<String>, pub created_by_church: bool, pub field_category: DbFieldCategory, pub field_type: DbFieldType, pub hide_in_frontend: bool, pub id: i64, pub is_basic_info: bool, pub is_not_configurable: bool, pub is_nullable: bool, pub key: String, pub name_translated: String, pub not_configurable: Option<bool>, pub nullable: Option<bool>, pub options: Option<Vec<DbFieldOption>>, pub extra: Map<String, Value>,
}
Expand description

Database-field definition. key is the API property name used when reading or writing a person/group value; column is its underlying database column. fieldCategory and fieldType describe ownership and value behavior. Installation-created fields have createdByChurch=true; built-in fields expose fewer editable settings.

Fields§

§delete_on_archive: bool

Whether a person field’s value is cleared on archiving. Cannot be true for a non-nullable field.

§is_active: bool

Whether the field is enabled for normal use.

§is_available_in_routines: bool

Whether routines may use this field.

§is_new_person_field: bool

Whether the field is available on new-person forms; primarily relevant to person categories.

§length: Option<i64>

Configured field length.

§line_ending: Option<String>
👎Deprecated:

deprecated in the ChurchTools API

Legacy display-layout setting, retained for compatibility.

§name: String

Stored display name or translation key. nameTranslated is its localized display text.

§security_level: i64

Security-level ID governing access to this field, resolved from installation masterdata.

§shorty: Option<String>

Abbreviated label.

§sort_key: i64

Display-order value within its category.

§use_as_placeholder: bool

Whether the field may be used as a placeholder.

§deprecated: DbFieldDeprecated

Compatibility mappings emitted by the backend.

§column: Option<String>
👎Deprecated:

deprecated in the ChurchTools API

Underlying database column; prefer key for API requests.

§created_by_church: bool

True for a custom field created by this ChurchTools installation.

§field_category: DbFieldCategory

Stored field category and its underlying entity table. Use internCode when creating a field.

§field_type: DbFieldType

Database-field type definition. internCode selects the input/validation behavior; the numeric ID is referenced by field definitions. The name can be a translation key.

§hide_in_frontend: bool

Stored flag controlling frontend visibility; current updates reset it to false.

§id: i64

Field-definition ID used in /dbfields paths.

§is_basic_info: bool

Whether the field is marked as basic information; current updates reset it to false.

§is_not_configurable: bool

Whether the field is marked as non-configurable; current updates reset it to false.

§is_nullable: bool

Whether stored field values may be null. Custom checkbox fields are non-nullable.

§key: String

API property name. Built-in columns are mapped to API names; custom fields normally retain their generated column name.

§name_translated: String

Localized display name for the current language.

§not_configurable: Option<bool>
👎Deprecated:

deprecated in the ChurchTools API

Deprecated alias of isNotConfigurable.

§nullable: Option<bool>
👎Deprecated:

deprecated in the ChurchTools API

Deprecated alias of isNullable.

§options: Option<Vec<DbFieldOption>>

Optional choices, included by an unfiltered list with include[]=options. The row shape depends on the field. Campus and group-visibility fields use specialized representations in this expansion.

§extra: Map<String, Value>

Fields not described by the spec, e.g. instance-specific DB fields.

Trait Implementations§

Source§

impl Clone for DbField

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 DbField

Source§

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

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

impl Default for DbField

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for DbField

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DbField

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 Serialize for DbField

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DbField

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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