extramojo
io
delimited
DelimWriter

DelimWriter

Mojo struct 🡭

DelimWriter

@memory_only
struct DelimWriter[W: Writer & Deinitable & Movable]

Write delimited data.

Parameters

  • W (Writer & Deinitable & Movable)

Fields

  • delim (String): The delimiter to use.
  • writer (BufferedWriter[W]): The BufferedWriter to write to.
  • write_header (Bool): Whether or not to write headers.
  • needs_to_write_header (Bool): Whether or not we need to write the headers still.

Implemented traits

AnyType, Deinitable, Movable

Methods

➕  ➖

__init__ 

def __init__(out self, var writer: BufferedWriter[W], *, var delim: String, write_header: Bool)

Create a DelimWriter.Args:

  • writer (BufferedWriter[W]): The BufferedWriter to write to.
  • delim (String): The delimiter to use.
  • write_header (Bool): Whether or not to write headers.
  • self (Self)

Returns:

Self

Raises:

def __init__(out self, *, deinit move: Self)

DetailsArgs:

  • move (Self)
  • self (Self)

Returns:

Self

__enter__ 

def __enter__(var self) -> Self

DetailsArgs:

  • self (Self)

Returns:

Self

flush 

def flush(mut self)

DetailsArgs:

  • self (Self)

close 

def close(mut self)

DetailsArgs:

  • self (Self)

Raises:

write_record 

def write_record[*Ts: Writable](mut self, *args: *Ts.values)

Write the passed in arguments as a delimited record.Parameters:

  • *Ts (Writable)

Args:

  • self (Self)
  • *args (*Ts.values)

Raises:

write_field 

def write_field[T: Writable](mut self, column: T, *, is_last: Bool)

Write a single field, delimited by the configured delimiter.Parameters:

  • T (Writable)

Args:

  • self (Self)
  • column (T)
  • is_last (Bool)

Raises:

serialize 

def serialize[T: ToDelimited](mut self, value: T)

Write a struct that implements ToDelimted to the underlying writer.Parameters:

  • T (ToDelimited)

Args:

  • self (Self)
  • value (T)

Raises:

DelimReaderFromDelimited