Serum.File (serum v1.5.1) View Source

Defines a struct representing a file to be read or written.

Fields

src: Source path
dest: Destination path
in_data: Data read from a file
out_data: Data to be written to a file

Link to this section Summary

Types

t()

Functions

read(file)

Reads data from a file described by the given Serum.File struct.

write(file)

Writes data to a file described by the given Serum.File struct.

Link to this section Types

t()

Specs

t() :: %Serum.File{
  dest: binary() | nil,
  in_data: IO.chardata() | String.Chars.t() | nil,
  out_data: IO.chardata() | String.Chars.t() | nil,
  src: binary() | nil
}

Link to this section Functions

read(file)

Specs

read(t()) :: Serum.Result.t(t())

Reads data from a file described by the given Serum.File struct.

An error will be returned if src is nil.

write(file)

Specs

write(t()) :: Serum.Result.t(t())

Writes data to a file described by the given Serum.File struct.

An error will be returned if dest is nil.