serum v1.0.0 Serum.File

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

Functions

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

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

Link to this section Types

Link to this type

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

Link to this section Functions

Link to this function

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

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

Link to this function

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

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