Saucexages v0.2.0 Saucexages.IO.BinaryWriter View Source

Functions for writing and maintaining SAUCE binaries.

Link to this section Summary

Removes any comments, if present from a SAUCE and rewrites the SAUCE accordingly

Removes a SAUCE block from a binary

Writes the given SAUCE block to the provided binary

remove_comments(bin)

remove_comments(binary()) ::
  {:ok, binary()} | {:error, :no_sauce} | {:error, term()}

Removes any comments, if present from a SAUCE and rewrites the SAUCE accordingly.

Can be used to remove a SAUCE comments block or to clean erroneous comment information such as mismatched comment lines or double comment blocks.

remove_sauce(bin)

remove_sauce(binary()) :: {:ok, binary()} | {:error, term()}

Removes a SAUCE block from a binary.

Both the SAUCE record and comments block will be removed.

write(bin, sauce_block)

write(binary(), Saucexages.SauceBlock.t()) :: {:ok, binary()} | {:error, term()}

Writes the given SAUCE block to the provided binary.