librarian

librarian v0.2.0 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

Callbacks

close(term)
connect(arg1)
connect(arg1, keyword)
connect!(arg1)
connect!(arg1, keyword)
fetch(arg1, arg2)
fetch(arg1, arg2, keyword)
fetch!(arg1, arg2)
fetch!(arg1, arg2, keyword)
run(arg1, arg2)
run(arg1, arg2, keyword)
run!(arg1, arg2)
run!(arg1, arg2, keyword)
send(arg1, iodata, arg3)
send(arg1, iodata, arg3, keyword)
send!(arg1, iodata, arg3)
send!(arg1, iodata, arg3, keyword)

Link to this section Callbacks

Link to this callback

close(term)

View Source

Specs

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

connect(arg1)

View Source (optional)

Specs

connect(SSH.remote()) :: SSH.connect_result()
Link to this callback

connect(arg1, keyword)

View Source

Specs

connect(SSH.remote(), keyword()) :: SSH.connect_result()
Link to this callback

connect!(arg1)

View Source (optional)

Specs

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

connect!(arg1, keyword)

View Source (optional)

Specs

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

fetch(arg1, arg2)

View Source (optional)

Specs

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

fetch(arg1, arg2, keyword)

View Source

Specs

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

fetch!(arg1, arg2)

View Source (optional)

Specs

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

fetch!(arg1, arg2, keyword)

View Source (optional)

Specs

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

run(arg1, arg2)

View Source (optional)

Specs

run(SSH.conn(), String.t()) :: SSH.run_result()
Link to this callback

run(arg1, arg2, keyword)

View Source

Specs

run(SSH.conn(), String.t(), keyword()) :: SSH.run_result()
Link to this callback

run!(arg1, arg2)

View Source (optional)

Specs

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

run!(arg1, arg2, keyword)

View Source (optional)

Specs

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

send(arg1, iodata, arg3)

View Source (optional)

Specs

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

send(arg1, iodata, arg3, keyword)

View Source

Specs

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

send!(arg1, iodata, arg3)

View Source (optional)

Specs

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

send!(arg1, iodata, arg3, keyword)

View Source (optional)

Specs

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