package
1.3.2
Repository: https://github.com/scrapli/scrapligo.git
Documentation: pkg.go.dev

# Functions

ByteContainsAny checks if byte slice b is contained in any byte slice in the slice of byte slices l.
ByteIsAny checks if byte b is contained in byte slice l.
BytesRoughlyContains returns true if all bytes from the given byte slice `input` exist in the given `output` byte slice -- the elements must be found in order.
GetCleanFunc is only used for testing -- it returns a function that "cleans" output (usually a "show run" type of output) of any data that may change over time -- things like timestamps and password hashes, this allows for comparing the stored "golden" test data against "new" output gleaned from test clab devices.
GetEnvIntOrDefault returns the value of the environment variable k as an int *or* the default d if casting fails or the environment variable is not set.
GetEnvStrOrDefault returns the value of the environment variable k as a string *or* the default d if casting fails or the environment variable is not set.
LoadFileLines convenience function to load a file and return slice of strings of lines in that file.
NewQueue returns a prepared Queue object.
PlatformOK is only used for testing and checks if the cli flag platforms is either "all" or contains the requested platform name platformName.
ResolveAtFileOrURL returns the bytes from `path` where path is either a filepath or URL.
ResolveFilePath resolves the qualified path to file string f.
StringContainsAny checks if string s is in the string slice l, this function returns a bool indicating inclusion or not.
StringContainsAnySubStrs checks if a string s is in the string slice l and returns the first encountered substring.
StringSliceContains checks if the string slice ss contains the substring s.
StripANSI removes ANSI escape codes from the given byte slice b.
TextFsmParse parses recorded output w/ a provided textfsm template.
TransportOK is only used for testing and checks if the cli flag transports is either "all" or contains the requested transport name transportName.

# Constants

Admin used for functional test user/pass.
All used for test flags for platform/transport.
MaxTimeout is the maximum timeout value used in scrapligo.

# Variables

ErrAuthError is returned if any authentication errors are returned.
ErrBadOption is returned when a bad value is passed to an option function.
ErrConnectionError is the error returned for non auth related connection failures typically encountered during *in channel ssh authentication* -- things like host key verification failures and other openssh errors.
ErrFileNotFoundError is returned if a file cannot be found.
ErrIgnoredOption is the error returned when attempting to apply an option to a struct that is not of the expected type.
ErrNetconfError is a blanket error for NETCONF issues that don't fall into another more explicit error.
ErrNoOp is an error returned when a "no op" event happens -- that is a SendCommands or SendConfigs method is called with an empty command/config slice provided.
ErrOperationError is returned for any "operation" issues -- mostly meaning ops timeouts.
ErrParseError is returned when parsing contents/files fails.
ErrPlatformError is returned for any "platform" issues.
ErrPrivilegeError is returned if there are any issues acquiring a privilege level or a user requests an invalid privilege level etc..
ErrTimeoutError is returned for any scrapligo timeout issues, meaning socket, transport or channel (ops) timeouts.

# Structs

PayloadTestCase is a simple struct used in testing only.
Queue is a simple queue structure to store and queue/requeue/dequeue bytes.

# Type aliases

Option is a simple type that accepts an interface and returns an error; this should only be used in the context of applying options to an object.