Struct vector_core::config::output_id::OutputId

pub struct OutputId {
    pub component: ComponentKey,
    pub port: Option<String>,
}

Component output identifier.

Fields

component: ComponentKey

The component to which the output belongs.

port: Option<String>

The output port name, if not the default.

Implementations

impl OutputId

pub fn dummy() -> Self

Some situations, for example when validating a config file requires running the transforms::output function to retrieve the outputs, but we don’t have an OutputId from a source. This gives us an OutputId that we can use.

TODO: This is not a pleasant solution, but would require some significant refactoring to the topology code to avoid.

pub fn with_definitions( &self, definitions: impl IntoIterator<Item = Definition>, ) -> Vec<(OutputId, Definition)>

Given a list of schema::Definitions, returns a Vec of tuples of this OutputId with each Definition.

Trait Implementations

impl Clone for OutputId

fn clone(&self) -> OutputId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for OutputId

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for OutputId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OutputId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OutputId

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

Formats the value using the given formatter.

impl From<&ComponentKey> for OutputId

fn from(key: &ComponentKey) -> Self

Converts to this type from the input type.

impl From<(&ComponentKey, String)> for OutputId

fn from((key, name): (&ComponentKey, String)) -> Self

Converts to this type from the input type.

impl From<(String, Option<String>)> for OutputId

fn from((component, port): (String, Option<String>)) -> Self

Converts to this type from the input type.

impl From<ComponentKey> for OutputId

fn from(key: ComponentKey) -> Self

Converts to this type from the input type.

impl From<OutputId> for OutputId

fn from(value: OutputId) -> Self

Converts to this type from the input type.

impl From<OutputId> for OutputId

fn from(value: OutputId) -> Self

Converts to this type from the input type.

impl Hash for OutputId

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 OutputId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for OutputId

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl Eq for OutputId

impl StructuralPartialEq for OutputId