librarian v0.1.10 SSH.Api behaviour View Source

You might want to run mocked tests against a component that uses the SSH Api. Here is provided the behaviour module to support this testing pattern.

generally speaking, these sorts of features should not be using the quick-and-dirty banged commands, so only the api for the fully error-tupled forms is provided.

Link to this section Summary

Link to this section Callbacks

Link to this callback

close(term)

View Source
close(term()) :: :ok | {:error, String.t()}
Link to this callback

connect!(arg1)

View Source (optional)
connect!(SSH.remote()) :: SSH.conn() | no_return()
Link to this callback

connect!(arg1, keyword)

View Source (optional)
connect!(SSH.remote(), keyword()) :: SSH.conn() | no_return()
Link to this callback

fetch(arg1, arg2)

View Source (optional)
fetch(SSH.conn(), Path.t()) :: SSH.fetch_result()
Link to this callback

fetch(arg1, arg2, keyword)

View Source
fetch(SSH.conn(), Path.t(), keyword()) :: SSH.fetch_result()
Link to this callback

fetch!(arg1, arg2)

View Source (optional)
fetch!(SSH.conn(), Path.t()) :: binary() | no_return()
Link to this callback

fetch!(arg1, arg2, keyword)

View Source (optional)
fetch!(SSH.conn(), Path.t(), keyword()) :: binary() | no_return()
Link to this callback

run(arg1, arg2)

View Source (optional)
Link to this callback

run!(arg1, arg2)

View Source (optional)
run!(SSH.conn(), String.t()) :: iodata() | {String.t(), String.t()}
Link to this callback

run!(arg1, arg2, keyword)

View Source (optional)
run!(SSH.conn(), String.t(), keyword()) :: iodata() | {String.t(), String.t()}
Link to this callback

send(arg1, iodata, arg3)

View Source (optional)
send(SSH.conn(), iodata(), Path.t()) :: SSH.send_result()
Link to this callback

send(arg1, iodata, arg3, keyword)

View Source
send(SSH.conn(), iodata(), Path.t(), keyword()) :: SSH.send_result()
Link to this callback

send!(arg1, iodata, arg3)

View Source (optional)
send!(SSH.conn(), iodata(), Path.t()) :: :ok | no_return()
Link to this callback

send!(arg1, iodata, arg3, keyword)

View Source (optional)
send!(SSH.conn(), iodata(), Path.t(), keyword()) :: :ok | no_return()