Struct NewlineDelimitedDecoderOptions 

pub struct NewlineDelimitedDecoderOptions {
    pub max_length: Option<usize>,
    pub oversized_action: OversizedAction,
}

Options for building a NewlineDelimitedDecoder.

Fields

max_length: Option<usize>

The maximum length of the byte buffer.

This length does not include the trailing delimiter.

By default, no maximum length is 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 prevents processing from being unbounded.

oversized_action: OversizedAction

The behavior when a line exceeds max_length.

When set to drop (the default), the entire oversized line is discarded. When set to truncate, the line is truncated to max_length bytes and the remainder is discarded up to the next newline.

This option has no effect if max_length is not set.

Implementations

impl NewlineDelimitedDecoderOptions

pub const fn new_with_max_length(max_length: usize) -> Self

Creates a NewlineDelimitedDecoderOptions with a maximum frame length limit.

Trait Implementations

impl Clone for NewlineDelimitedDecoderOptions

fn clone(&self) -> NewlineDelimitedDecoderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for NewlineDelimitedDecoderOptions

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 NewlineDelimitedDecoderOptions

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

Formats the value using the given formatter.

impl Default for NewlineDelimitedDecoderOptions

fn default() -> NewlineDelimitedDecoderOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NewlineDelimitedDecoderOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NewlineDelimitedDecoderOptions

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

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 NewlineDelimitedDecoderOptions

fn to_value(&self) -> Value

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

impl Eq for NewlineDelimitedDecoderOptions

impl StructuralPartialEq for NewlineDelimitedDecoderOptions