clamxir v0.1.1 Clamxir

Documentation for Clamxir.

Link to this section Summary

Functions

Returns a tuple with the result of the function

Returns a tuple if the scanner exists

Return boolean with the result if succeded. Otherwhise, a tuple with {:error, message}

Link to this section Functions

Link to this function add_fdpass(command, arg2)
Link to this function add_stream(command, arg2)
Link to this function create_args(clamxir_config, path)
Link to this function file_exists?(path)

Returns a tuple with the result of the function.

Examples

iex> Clamxir.file_exists?(“README.md”)

iex> Clamxir.file_exists?(“NO_FILE.md”)

Link to this function run_command(clamxir_config, path)
Link to this function safe?(clamxir_config, path)
Link to this function scanner_exists?(clamxir_config)

Returns a tuple if the scanner exists

Examples

iex> Clamxir.scanner_exists?(%Clamxir{}) true

iex> Clamxir.scanner_exists?(%Clamxir{check: true}) true

Link to this function virus?(clamxir_config, path)

Return boolean with the result if succeded. Otherwhise, a tuple with {:error, message}

Examples

iex> Clamxir.virus?(%Clamxir{}, “README.md”) false

iex> Clamxir.virus?(%Clamxir{}, “NOT_FOUND.md”)