Struct Relation 

pub struct Relation {

    pub id: String,
    pub key: String,
    pub format: i32,
    pub name: String,
    pub default_value: Option<Value>,
    pub data_source: i32,
    pub hidden: bool,
    pub read_only: bool,
    pub read_only_relation: bool,
    pub multi: bool,
    pub object_types: Vec<String>,
    pub select_dict: Vec<Option>,
    pub max_count: i32,
    pub description: String,
    pub scope: i32,
    pub creator: String,
    pub revision: i64,
    pub include_time: bool,
}

Relation describe the human-interpreted relation type. It may be something like “Date of creation, format=date” or “Assignee, format=objectId, objectType=person”

Fields

id: String

key: String

Key under which the value is stored in the map. Must be unique for the object type. It usually auto-generated bsonid, but also may be something human-readable in case of prebuilt types.

format: i32

format of the underlying data

name: String

name to show (can be localized for bundled types)

default_value: Option<Value>

data_source: i32

where the data is stored

hidden: bool

internal, not displayed to user (e.g. coverX, coverY)

read_only: bool

value not editable by user tobe renamed to readonlyValue

read_only_relation: bool

relation metadata, eg name and format is not editable by user

multi: bool

allow multiple values (stored in pb list)

object_types: Vec<String>

URL of object type, empty to allow link to any object

select_dict: Vec<Option>

index 10, 11 was used in internal-only builds. Can be reused, but may break some test accounts

default dictionary with unique values to choose for select/multiSelect format

max_count: i32

max number of values can be set for this relation. 0 means no limit. 1 means the value can be stored in non-repeated field

description: String

scope: i32

on-store fields, injected only locally

deprecated, to be removed

creator: String

creator profile id

revision: i64

revision of system relation. Used to check if we should change relation content or not

include_time: bool

indicates whether value of relation with date format should be processed with seconds precision

Implementations

impl Relation

pub fn format(&self) -> RelationFormat

Returns the enum value of format, or the default if the field is set to an invalid enum value.

pub fn set_format(&mut self, value: RelationFormat)

Sets format to the provided enum value.

pub fn data_source(&self) -> DataSource

Returns the enum value of data_source, or the default if the field is set to an invalid enum value.

pub fn set_data_source(&mut self, value: DataSource)

Sets data_source to the provided enum value.

pub fn scope(&self) -> Scope

Returns the enum value of scope, or the default if the field is set to an invalid enum value.

pub fn set_scope(&mut self, value: Scope)

Sets scope to the provided enum value.

Trait Implementations

impl Clone for Relation

fn clone(&self) -> Relation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Relation

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

Formats the value using the given formatter.

impl Default for Relation

fn default() -> Self

Returns the “default value” for a type.

impl Message for Relation

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Relation

fn eq(&self, other: &Relation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Relation