Struct ConfigurableField 

pub struct ConfigurableField {
    pub id: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub annotation: Option<String>,
    pub is_shared: bool,
}

Field that can be configured by the user.

This corresponds to Python’s ConfigurableField NamedTuple.

Fields

id: String

The unique identifier of the field

name: Option<String>

The name of the field

description: Option<String>

The description of the field

annotation: Option<String>

The annotation of the field (type hint as string in Rust)

is_shared: bool

Whether the field is shared across runnables

Implementations

impl ConfigurableField

pub fn new(id: impl Into<String>) -> Self

pub fn with_name(self, name: impl Into<String>) -> Self

pub fn with_description(self, description: impl Into<String>) -> Self

pub fn with_annotation(self, annotation: impl Into<String>) -> Self

pub fn with_shared(self, is_shared: bool) -> Self

Trait Implementations

impl Clone for ConfigurableField

fn clone(&self) -> ConfigurableField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurableField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigurableField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ConfigurableField

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConfigurableField

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConfigurableField

impl StructuralPartialEq for ConfigurableField