Struct LabelValueDefinition 

pub struct LabelValueDefinition<S: BosStr = DefaultStr> {
    pub adult_only: Option<bool>,
    pub blurs: LabelValueDefinitionBlurs<S>,
    pub default_setting: Option<LabelValueDefinitionDefaultSetting<S>>,
    pub identifier: S,
    pub locales: Vec<LabelValueDefinitionStrings<S>>,
    pub severity: LabelValueDefinitionSeverity<S>,
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

Declares a label value and its expected interpretations and behaviors.

Fields

adult_only: Option<bool>

Does the user need to have adult content enabled in order to configure this label?

blurs: LabelValueDefinitionBlurs<S>

What should this label hide in the UI, if applied? ‘content’ hides all of the target; ‘media’ hides the images/video/audio; ‘none’ hides nothing.

default_setting: Option<LabelValueDefinitionDefaultSetting<S>>

The default setting for this label.

identifier: S

The value of the label being defined. Must only include lowercase ascii and the ‘-’ character ([a-z-]+).

locales: Vec<LabelValueDefinitionStrings<S>>

severity: LabelValueDefinitionSeverity<S>

How should a client visually convey this label? ‘inform’ means neutral and informational; ‘alert’ means negative and warning; ‘none’ means show nothing.

extra_data: Option<BTreeMap<SmolStr, Data<S>>>

Implementations

impl LabelValueDefinition<DefaultStr>

pub fn new() -> LabelValueDefinitionBuilder<Empty, DefaultStr>

Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed

impl<S: BosStr> LabelValueDefinition<S>

pub fn builder() -> LabelValueDefinitionBuilder<Empty, S>

Create a new builder for this type

Trait Implementations

impl<S: Clone + BosStr> Clone for LabelValueDefinition<S>

fn clone(&self) -> LabelValueDefinition<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + BosStr> Debug for LabelValueDefinition<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for LabelValueDefinition<S>

where S: Deserialize<'de> + BosStr,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: Eq + BosStr> Eq for LabelValueDefinition<S>

impl<S: BosStr + IntoStatic> IntoStatic for LabelValueDefinition<S>

where <S as IntoStatic>::Output: BosStr,

type Output = LabelValueDefinition<<S as IntoStatic>::Output>

The “owned” variant of the type. For Cow<'a, str>, this is Cow<'static, str>, for example.

fn into_static(self) -> Self::Output

Turns the value into an “owned” variant, which can then be returned, moved, etc.

impl<S: BosStr> LexiconSchema for LabelValueDefinition<S>

fn nsid() -> &'static str

The NSID for this type’s primary definition

fn def_name() -> &'static str

The definition name within the lexicon document

fn lexicon_doc() -> LexiconDoc<'static>

Generate the lexicon document for this type

fn validate(&self) -> Result<(), ConstraintError>

Validate an instance against lexicon constraints

fn schema_id() -> CowStr<'static>

The schema ID for this type

fn inline_schema() -> bool

Whether this type should be inlined vs referenced

impl<S: PartialEq + BosStr> PartialEq for LabelValueDefinition<S>

fn eq(&self, other: &LabelValueDefinition<S>) -> 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<S> Serialize for LabelValueDefinition<S>

where S: Serialize + BosStr,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: BosStr> StructuralPartialEq for LabelValueDefinition<S>