Struct ConfigProperty

Source

pub struct ConfigProperty {
    pub property_type: PropertyType,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub validation: Option<PropertyValidation>,
    pub deprecated: Option<bool>,
}

Expand description

Configuration property definition

Fields§

§property_type: PropertyType

Property type

§description: Option<String>

Property description

§default: Option<Value>

Default value

§validation: Option<PropertyValidation>

Validation rules

§deprecated: Option<bool>

Whether the property is deprecated

Implementations§

Source §

impl ConfigProperty

Source

pub fn new(property_type: PropertyType) -> ConfigProperty

Create new property

Source

pub fn with_description(self, description: String) -> ConfigProperty

Set description

Source

pub fn with_default(self, default: Value) -> ConfigProperty

Set default value

Source

pub fn with_validation(self, validation: PropertyValidation) -> ConfigProperty

Set validation

Source

pub fn deprecated(self) -> ConfigProperty

Mark as deprecated

Source

pub fn validate(&self, name: &str) -> Result<(), PluginError>

Validate property definition

Source

pub fn validate_value(&self, value: &Value) -> Result<(), PluginError>

Validate a value against this property

Trait Implementations§

Source §

impl Clone for ConfigProperty

Source §

fn clone(&self) -> ConfigProperty

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ConfigProperty

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for ConfigProperty

Source §

fn deserialize<D>( deserializer: D, ) -> Result<ConfigProperty, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Serialize for ConfigProperty

Source §

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ConfigProperty

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> FromRef<T> for T
where T: Clone,

Source §

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

Source §

impl<T> GetSetFdFlags for T

Source §

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.

Source §

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more

Source §

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §