Struct Csv

#[non_exhaustive]
pub struct Csv {
    pub quote_character: Option<String>,
    pub delimiter: Option<String>,
    pub columns: Option<Vec<String>>,
    pub source: Option<String>,
}

The CSV processor parses comma-separated values (CSV) from the log events into columns.

For more information about this processor including examples, see csv in the CloudWatch Logs User Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

quote_character: Option<String>

The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark " character is used.

delimiter: Option<String>

The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma , character as the delimiter.

columns: Option<Vec<String>>

An array of names to use for the columns in the transformed log event.

If you omit this, default column names (\[column_1, column_2 ...\]) are used.

source: Option<String>

The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.

Implementations

impl Csv

pub fn quote_character(&self) -> Option<&str>

The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark " character is used.

pub fn delimiter(&self) -> Option<&str>

The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma , character as the delimiter.

pub fn columns(&self) -> &[String]

An array of names to use for the columns in the transformed log event.

If you omit this, default column names (\[column_1, column_2 ...\]) are used.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .columns.is_none().

pub fn source(&self) -> Option<&str>

The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.

impl Csv

pub fn builder() -> CsvBuilder

Creates a new builder-style object to manufacture Csv.

Trait Implementations

impl Clone for Csv

fn clone(&self) -> Csv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Csv

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

Formats the value using the given formatter.

impl PartialEq for Csv

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