Struct UnconfinedTemplate 

pub struct UnconfinedTemplate { /* private fields */ }

A templated field.

In many cases, components can be configured so that part of the component’s functionality can be customized on a per-event basis. By using UnconfinedTemplate, users can specify either fixed strings or templated strings. Templated strings use a common syntax to refer to fields in an event that is used as the input data when rendering the template.

Implementations

impl UnconfinedTemplate

pub const fn with_tz_offset(self, tz_offset: Option<FixedOffset>) -> Self

Set tz offset.

pub fn render<'a>( &self, event: impl Into<EventRef<'a>>, ) -> Result<Bytes, TemplateRenderingError>

Renders the given template with data from the event, returning raw bytes.

pub fn render_string<'a>( &self, event: impl Into<EventRef<'a>>, ) -> Result<String, TemplateRenderingError>

Renders the given template with data from the event.

pub fn get_fields(&self) -> Option<Vec<String>>

Returns the names of the fields that are rendered in this template.

pub fn literal_prefix(&self) -> &str

Longest leading substring of the template source that is rendered verbatim — no {{ field }} reference and no strftime specifier.

Sinks use this to derive a confinement boundary from the operator-authored portion of the template.

pub const fn get_ref(&self) -> &str

Returns a reference to the template string.

pub const fn is_empty(&self) -> bool

Returns true if this template string has a length of zero, and false otherwise.

pub const fn is_dynamic(&self) -> bool

A dynamic template string contains sections that depend on the input event or time.

Trait Implementations

impl Clone for UnconfinedTemplate

fn clone(&self) -> UnconfinedTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for UnconfinedTemplate

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 UnconfinedTemplate

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

Formats the value using the given formatter.

impl Default for UnconfinedTemplate

fn default() -> UnconfinedTemplate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnconfinedTemplate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UnconfinedTemplate

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

Formats the value using the given formatter.

impl From<UnconfinedTemplate> for String

fn from(template: UnconfinedTemplate) -> String

Converts to this type from the input type.

impl From<UnconfinedTemplate> for Template

fn from(inner: UnconfinedTemplate) -> Self

Converts to this type from the input type.

impl Hash for UnconfinedTemplate

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 UnconfinedTemplate

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

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 UnconfinedTemplate

fn to_value(&self) -> Value

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

impl TryFrom<&str> for UnconfinedTemplate

type Error = TemplateParseError

The type returned in the event of a conversion error.

fn try_from(src: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Cow<'_, str>> for UnconfinedTemplate

type Error = TemplateParseError

The type returned in the event of a conversion error.

fn try_from(src: Cow<'_, str>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PathBuf> for UnconfinedTemplate

type Error = TemplateParseError

The type returned in the event of a conversion error.

fn try_from(p: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for UnconfinedTemplate

type Error = TemplateParseError

The type returned in the event of a conversion error.

fn try_from(src: String) -> Result<Self, Self::Error>

Performs the conversion.

impl ConfigurableString for UnconfinedTemplate

impl Eq for UnconfinedTemplate

impl StructuralPartialEq for UnconfinedTemplate