Struct codecs::decoding::framing::CharacterDelimitedDecoderOptions

pub struct CharacterDelimitedDecoderOptions {
    pub delimiter: u8,
    pub max_length: Option<usize>,
}

Options for building a CharacterDelimitedDecoder.

Fields

delimiter: u8

The character that delimits byte sequences.

max_length: Option<usize>

The maximum length of the byte buffer.

This length does not include the trailing delimiter.

By default, there is no maximum length enforced. If events are malformed, this can lead to additional resource usage as events continue to be buffered in memory, and can potentially lead to memory exhaustion in extreme cases.

If there is a risk of processing malformed data, such as logs with user-controlled input, consider setting the maximum length to a reasonably large value as a safety net. This ensures that processing is not actually unbounded.

Implementations

impl CharacterDelimitedDecoderOptions

pub const fn new(delimiter: u8, max_length: Option<usize>) -> Self

Create a CharacterDelimitedDecoderOptions with a delimiter and optional max_length.

Trait Implementations

impl Clone for CharacterDelimitedDecoderOptions

fn clone(&self) -> CharacterDelimitedDecoderOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for CharacterDelimitedDecoderOptions

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 CharacterDelimitedDecoderOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CharacterDelimitedDecoderOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CharacterDelimitedDecoderOptions

fn eq(&self, other: &CharacterDelimitedDecoderOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CharacterDelimitedDecoderOptions

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 CharacterDelimitedDecoderOptions

fn to_value(&self) -> Value

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

impl Eq for CharacterDelimitedDecoderOptions

impl StructuralPartialEq for CharacterDelimitedDecoderOptions