extramojo
io
delimited
DelimWriter

DelimWriter

Mojo struct 🡭

DelimWriter

@memory_only
struct DelimWriter[W: Movable & Writer]

Write delimited data.

Parameters

  • W (Movable & Writer)

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, Movable, UnknownDestructibility

Methods

➕  ➖

__init__ 

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

Create a DelimWriter. Args:

  • writer (BufferedWriter): 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:

__moveinit__ 

@staticmethod
fn __moveinit__(out self, var existing: Self)

Details Args:

  • existing (Self)
  • self (Self)

Returns:

Self

__enter__ 

fn __enter__(var self) -> Self

Details Args:

  • self (Self)

Returns:

Self

flush 

fn flush(mut self)

Details Args:

  • self (Self)

close 

fn close(mut self)

Details Args:

  • self (Self)

Raises:

write_record 

fn write_record[*Ts: Writable](mut self, *args: *Ts)

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

  • *Ts (Writable)

Args:

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

Raises:

write_field 

fn 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 

fn 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