Expand description
FFI bindings for the Stumpless logging library.
These wrappings are intended to be the bare minimum to use Stumpless from a Rust application.
§Create Features
Stumpless provides a number of build configuration options that can be used to enable or disable different functionality. This crate exposes these options as the following features.
§Target Features
- journald - Enables targets that can send logs to a systemd journald daemon.
- network - Enables targets that can send logs to a server over a network connection.
- socket - Enables targets that can send logs to Unix sockets.
- wel - Enables targets that can send logs to the Windows Event Log.
Structs§
- _IO_
FILE - _IO_
codecvt - _IO_
marker - _IO_
wide_ data - stumpless_
element - An element of structured data.
- stumpless_
entry - A log entry.
- stumpless_
error - Information describing an error encountered by the library.
- stumpless_
param - A parameter within a structured data element.
- stumpless_
target - A target that log entries can be sent to.
- stumpless_
version - A description of a library version. This project follows semantic versioning.
Constants§
- stumpless_
error_ id_ STUMPLESS_ ADDRESS_ FAILURE - stumpless_
error_ id_ STUMPLESS_ ARGUMENT_ EMPTY - stumpless_
error_ id_ STUMPLESS_ ARGUMENT_ TOO_ BIG - stumpless_
error_ id_ STUMPLESS_ DUPLICATE_ ELEMENT - stumpless_
error_ id_ STUMPLESS_ ELEMENT_ NOT_ FOUND - stumpless_
error_ id_ STUMPLESS_ FILE_ OPEN_ FAILURE - stumpless_
error_ id_ STUMPLESS_ FILE_ WRITE_ FAILURE - stumpless_
error_ id_ STUMPLESS_ FUNCTION_ TARGET_ FAILURE - stumpless_
error_ id_ STUMPLESS_ GETHOSTNAME_ FAILURE - stumpless_
error_ id_ STUMPLESS_ INDEX_ OUT_ OF_ BOUNDS - stumpless_
error_ id_ STUMPLESS_ INVALID_ ENCODING - stumpless_
error_ id_ STUMPLESS_ INVALID_ FACILITY - stumpless_
error_ id_ STUMPLESS_ INVALID_ ID - stumpless_
error_ id_ STUMPLESS_ INVALID_ PARAM_ STRING - stumpless_
error_ id_ STUMPLESS_ INVALID_ SEVERITY - stumpless_
error_ id_ STUMPLESS_ JOURNALD_ FAILURE - stumpless_
error_ id_ STUMPLESS_ MEMORY_ ALLOCATION_ FAILURE - stumpless_
error_ id_ STUMPLESS_ NETWORK_ CLOSED - stumpless_
error_ id_ STUMPLESS_ NETWORK_ PROTOCOL_ UNSUPPORTED - stumpless_
error_ id_ STUMPLESS_ PARAM_ NOT_ FOUND - stumpless_
error_ id_ STUMPLESS_ SOCKET_ BIND_ FAILURE - stumpless_
error_ id_ STUMPLESS_ SOCKET_ CONNECT_ FAILURE - stumpless_
error_ id_ STUMPLESS_ SOCKET_ FAILURE - stumpless_
error_ id_ STUMPLESS_ SOCKET_ SEND_ FAILURE - stumpless_
error_ id_ STUMPLESS_ SQLIT E3_ BUSY - stumpless_
error_ id_ STUMPLESS_ SQLIT E3_ CALLBACK_ FAILURE - stumpless_
error_ id_ STUMPLESS_ SQLIT E3_ FAILURE - stumpless_
error_ id_ STUMPLESS_ STREAM_ WRITE_ FAILURE - stumpless_
error_ id_ STUMPLESS_ TARGET_ INCOMPATIBLE - stumpless_
error_ id_ STUMPLESS_ TARGET_ UNSUPPORTED - stumpless_
error_ id_ STUMPLESS_ TRANSPORT_ PROTOCOL_ UNSUPPORTED - stumpless_
error_ id_ STUMPLESS_ WINDOWS_ EVENT_ LOG_ CLOSE_ FAILURE - stumpless_
error_ id_ STUMPLESS_ WINDOWS_ EVENT_ LOG_ OPEN_ FAILURE - stumpless_
error_ id_ STUMPLESS_ WINDOWS_ FAILURE - stumpless_
facility_ STUMPLESS_ FACILITY_ ALERT - stumpless_
facility_ STUMPLESS_ FACILITY_ AUDIT - stumpless_
facility_ STUMPLESS_ FACILITY_ AUTH - stumpless_
facility_ STUMPLESS_ FACILITY_ AUTH2 - stumpless_
facility_ STUMPLESS_ FACILITY_ CRON - stumpless_
facility_ STUMPLESS_ FACILITY_ CRON2 - stumpless_
facility_ STUMPLESS_ FACILITY_ DAEMON - stumpless_
facility_ STUMPLESS_ FACILITY_ FTP - stumpless_
facility_ STUMPLESS_ FACILITY_ KERN - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L0 - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L1 - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L2 - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L3 - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L4 - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L5 - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L6 - stumpless_
facility_ STUMPLESS_ FACILITY_ LOCA L7 - stumpless_
facility_ STUMPLESS_ FACILITY_ LPR - stumpless_
facility_ STUMPLESS_ FACILITY_ MAIL - stumpless_
facility_ STUMPLESS_ FACILITY_ NEWS - stumpless_
facility_ STUMPLESS_ FACILITY_ NTP - stumpless_
facility_ STUMPLESS_ FACILITY_ SYSLOG - stumpless_
facility_ STUMPLESS_ FACILITY_ USER - stumpless_
facility_ STUMPLESS_ FACILITY_ UUCP - stumpless_
network_ protocol_ STUMPLESS_ IPV4_ NETWORK_ PROTOCOL - < Internet Protocol version 4, RFC 791
- stumpless_
network_ protocol_ STUMPLESS_ IPV6_ NETWORK_ PROTOCOL - < Internet Protocl version 6, RFC 8200
- stumpless_
severity_ STUMPLESS_ SEVERITY_ ALERT - stumpless_
severity_ STUMPLESS_ SEVERITY_ CRIT - stumpless_
severity_ STUMPLESS_ SEVERITY_ DEBUG - stumpless_
severity_ STUMPLESS_ SEVERITY_ EMERG - stumpless_
severity_ STUMPLESS_ SEVERITY_ ERR - stumpless_
severity_ STUMPLESS_ SEVERITY_ INFO - stumpless_
severity_ STUMPLESS_ SEVERITY_ NOTICE - stumpless_
severity_ STUMPLESS_ SEVERITY_ WARNING - stumpless_
target_ type_ STUMPLESS_ BUFFER_ TARGET - stumpless_
target_ type_ STUMPLESS_ CHAIN_ TARGET - stumpless_
target_ type_ STUMPLESS_ FILE_ TARGET - stumpless_
target_ type_ STUMPLESS_ FUNCTION_ TARGET - stumpless_
target_ type_ STUMPLESS_ JOURNALD_ TARGET - stumpless_
target_ type_ STUMPLESS_ NETWORK_ TARGET - stumpless_
target_ type_ STUMPLESS_ SOCKET_ TARGET - stumpless_
target_ type_ STUMPLESS_ SQLIT E3_ TARGET - stumpless_
target_ type_ STUMPLESS_ STREAM_ TARGET - stumpless_
target_ type_ STUMPLESS_ WINDOWS_ EVENT_ LOG_ TARGET - stumpless_
transport_ protocol_ STUMPLESS_ TCP_ TRANSPORT_ PROTOCOL - < TCP, RFC 793
- stumpless_
transport_ protocol_ STUMPLESS_ UDP_ TRANSPORT_ PROTOCOL - < UDP, RFC 768
Functions§
- stump⚠
- Logs a message to the default target.
- stump_
str ⚠ - Logs a message to the default target.
- stump_
trace ⚠ - Logs a message to the default target, along with the file, line, and function information specified in a structured data element.
- stump_
trace_ ⚠str - Logs a message to the default target, along with the file, line, and function information specified in a structured data element.
- stumpless_
add_ ⚠element - Adds an element to an entry. The element is appended to the end of the list of elements in this entry.
- stumpless_
add_ ⚠entry - Adds an entry into a given target. This is the primary logging function of stumpless; all other logging functions call this one after performing any setup specific to themselves.
- stumpless_
add_ ⚠log - Adds a log message with a priority to a given target.
- stumpless_
add_ ⚠log_ str - Adds a log message with a priority to a given target.
- stumpless_
add_ ⚠message - Adds a message to a given target.
- stumpless_
add_ ⚠message_ str - Adds a string message to a given target.
- stumpless_
add_ ⚠new_ element - Creates a new element with the given name and adds it to this entry.
- stumpless_
add_ ⚠new_ param - Creates a new param and adds it to the given element.
- stumpless_
add_ ⚠new_ param_ to_ entry - Creates a new param and adds it to the given element in the given entry. If an element with the given name does not exist in the given entry, then one will be created with the new param added to it.
- stumpless_
add_ ⚠param - Adds a param to an element.
- stumpless_
add_ ⚠target_ to_ chain - Adds a target to an existing chain target.
- stumpless_
close_ ⚠buffer_ target - Closes a buffer target.
- stumpless_
close_ ⚠chain_ and_ contents - Closes a chain of targets.
- stumpless_
close_ ⚠chain_ only - Closes a chain target.
- stumpless_
close_ ⚠file_ target - Closes a file target.
- stumpless_
close_ ⚠function_ target - Closes a function target.
- stumpless_
close_ ⚠network_ target - Closes a network target.
- stumpless_
close_ ⚠sqlite3_ target_ and_ db - Closes a SQLite3 target and its database handle.
- stumpless_
close_ ⚠sqlite3_ target_ only - Closes a SQLite3 target, but does not touch the database handle.
- stumpless_
close_ ⚠stream_ target - Closes a stream target.
- stumpless_
close_ ⚠target - Closes a target.
- stumpless_
copy_ ⚠element - Creates a copy of an element.
- stumpless_
copy_ ⚠entry - Creates a copy of an entry.
- stumpless_
copy_ ⚠param - Creates a copy of a param.
- stumpless_
create_ ⚠default_ sqlite3_ table - Creates a table in the target’s database for use with the default SQLite3 insertion behavior. The schema of this table is described below. Note that the value of \c STUMPLESS_DEFAULT_SQLITE3_TABLE_NAME_STRING is configurable and set at build time for the library.
- stumpless_
destroy_ ⚠element - An alias for stumpless_destroy_element_and_contents.
- stumpless_
destroy_ ⚠element_ and_ contents - Destroys an element as well as all params that it contains, freeing any allocated memory.
- stumpless_
destroy_ ⚠element_ only - Destroys an element, freeing any allocated memory. Associated params are left untouched, and must be destroyed separately.
- stumpless_
destroy_ ⚠entry - An alias for stumpless_destroy_entry_and_contents.
- stumpless_
destroy_ ⚠entry_ and_ contents - Destroys an entry as well as all elements and params that it contains, freeing any allocated memory.
- stumpless_
destroy_ ⚠entry_ only - Destroys an entry, freeing any allocated memory. Associated elements and params are left untouched, and must be destroyed separately.
- stumpless_
destroy_ ⚠param - Destroys a param, freeing any allocated memory.
- stumpless_
element_ ⚠has_ param - True if the given element has a param with the given name, false otherwise.
- stumpless_
element_ ⚠to_ string - Returns name and params from element as a formatted string. The character buffer should be freed when no longer is needed by the caller.
- stumpless_
entry_ ⚠has_ element - True if the given entry has an element with the given name, false otherwise.
- stumpless_
free_ ⚠all - Closes the default target if it has been opened, frees all memory allocated internally, and performs any other necessary cleanup.
- stumpless_
free_ ⚠thread - Frees all memory allocated internally to the calling thread, and performs any other thread-specific cleanup.
- stumpless_
get_ ⚠chain_ length - Gets the number of targets currently in a chain.
- stumpless_
get_ ⚠cons_ stream - stumpless_
get_ ⚠current_ target - Gets the current target.
- stumpless_
get_ ⚠default_ facility - Gets the default facility of a target.
- stumpless_
get_ ⚠default_ target - Gets the default target.
- stumpless_
get_ ⚠destination - Gets the destination of a network target. The character buffer returned must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠element_ by_ index - Returns the element at the given index in this Entry.
- stumpless_
get_ ⚠element_ by_ name - Returns the element with the given name in this entry, if it is found.
- stumpless_
get_ ⚠element_ count - Returns the number of elements in the given entry.
- stumpless_
get_ ⚠element_ index - Returns the index of the element with the given name in this entry, if it is found.
- stumpless_
get_ ⚠element_ name - Returns the name of the given element. The character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ app_ name - Returns the app name of the given entry. The character buffer returned must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ facility - Returns the facility code of the given entry.
- stumpless_
get_ ⚠entry_ hostname - Returns the hostname of a given entry. If hostname is not set it will return the machine hostname. The result character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ message - Returns the message of the given entry. The character buffer returned must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ msgid - Returns the msgid of the given entry. The character buffer returned must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ param_ by_ index - Gets the param from the element at the given index in an entry.
- stumpless_
get_ ⚠entry_ param_ by_ name - Gets the first param from the element with the given name in an entry.
- stumpless_
get_ ⚠entry_ param_ value_ by_ index - Gets the value of the param from the element at the given index in an entry. The result character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ param_ value_ by_ name - Gets the value of the first param from the element with the given name in an entry. The result character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ prival - Returns the prival of the given entry, as defined in RFC 5424.
- stumpless_
get_ ⚠entry_ procid - Returns the procid of a given entry. If procid is not set it will return the ProcessID. The result character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠entry_ severity - Returns the severity code of the given entry.
- stumpless_
get_ ⚠error - Retrieves the error encountered by the last library call.
- stumpless_
get_ ⚠error_ id - Gets the error id of the given error.
- stumpless_
get_ ⚠error_ id_ string - Gets the error string of the given error id.
- stumpless_
get_ ⚠error_ stream - Gets the current stream that errors are written to.
- stumpless_
get_ ⚠facility_ enum - Gets the enum value corresponding to the given facility string.
- stumpless_
get_ ⚠facility_ enum_ from_ buffer - Gets the enum value corresponding to the given facility string.
- stumpless_
get_ ⚠facility_ string - Gets the string representation of the given facility.
- stumpless_
get_ ⚠network_ protocol - Gets the network protocol of a network target.
- stumpless_
get_ ⚠option - Gets a given option of a target.
- stumpless_
get_ ⚠param_ by_ index - Returns the param in the given element at the specified index.
- stumpless_
get_ ⚠param_ by_ name - Returns the first occurrence of a param with the given name in element, if it is found.
- stumpless_
get_ ⚠param_ count - Returns the number of params in the given element.
- stumpless_
get_ ⚠param_ index - Gives the index of the first occurrence of a param with the given name in the given element.
- stumpless_
get_ ⚠param_ name - Returns the name of the given param. The character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠param_ name_ by_ index - Gets the name of the param with the given index in this element. The result character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠param_ name_ count - Gives the number of params with the given name found in the given element.
- stumpless_
get_ ⚠param_ value - Returns the value of the given param. The character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠param_ value_ by_ index - Returns the value of the param at the given index in the given element. The result character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠param_ value_ by_ name - Returns the value of the first param with the given name in the given element. The result character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠prival_ string - Gets the string representation of the given prival.
- stumpless_
get_ ⚠severity_ enum - Gets the enum value corresponding to the given severity string.
- stumpless_
get_ ⚠severity_ enum_ from_ buffer - Gets the enum value corresponding to the given severity string in a buffer.
- stumpless_
get_ ⚠severity_ string - Gets the string representation of the given severity.
- stumpless_
get_ ⚠sqlite3_ db - Gets the SQLite3 database handle used by the target.
- stumpless_
get_ ⚠sqlite3_ insert_ sql - Gets the SQL statement used to insert entries into the database. See \ref stumpless_set_sqlite3_insert_sql to change this statement.
- stumpless_
get_ ⚠sqlite3_ prepare - Gets the preparation function and data pointer used to prepare statements for insertion into the database. See \ref stumpless_set_sqlite3_prepare to change this function.
- stumpless_
get_ ⚠target_ default_ app_ name - Returns the default app name of the given target. The character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠target_ default_ msgid - Returns the default msgid of the given target. The character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠target_ filter - Returns the current filter used by the given target to determine if entries should be allowed through it.
- stumpless_
get_ ⚠target_ mask - Gets the log mask of a target.
- stumpless_
get_ ⚠target_ name - Returns the name of the given target. The character buffer must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠target_ type_ string - Gets the string representation of the given target_type.
- stumpless_
get_ ⚠transport_ port - Gets the transport port number of a network target. The character buffer returned must be freed by the caller when it is no longer needed to avoid memory leaks.
- stumpless_
get_ ⚠transport_ protocol - Gets the transport protocol of a network target.
- stumpless_
get_ ⚠udp_ max_ message_ size - Gets the current maximum message size of a UDP network target.
- stumpless_
get_ ⚠version - Gets the version of code the library was built with. This version must be freed by the caller when it is no longer needed to avoid a memory leak.
- stumpless_
has_ ⚠error - True if the last call to a stumpless function encountered an error. To get the error itself, use the stumpless_get_error function.
- stumpless_
load_ ⚠element - Loads a provided element with the given name.
- stumpless_
load_ ⚠entry - Loads an entry struct with the given characteristics.
- stumpless_
load_ ⚠entry_ str - Creates a new entry with the given characteristics.
- stumpless_
load_ ⚠param - Loads a provided param with the given values.
- stumpless_
mask_ ⚠filter - Compares the severity of the entry to the current mask of the target, and only passes the entry if the mask bit corresponding to the severity is set.
- stumpless_
new_ ⚠chain - Creates a new target chain.
- stumpless_
new_ ⚠element - Creates a new element with the given name.
- stumpless_
new_ ⚠entry - Creates a new entry with the given characteristics.
- stumpless_
new_ ⚠entry_ str - Creates a new entry with the given characteristics.
- stumpless_
new_ ⚠network_ target - Creates a network target, but does not open it.
- stumpless_
new_ ⚠param - Creates a new param with the given name and value.
- stumpless_
new_ ⚠param_ from_ string - Creates a new param given a string by parsing the string and calling stumpless_new_param.
- stumpless_
new_ ⚠tcp4_ target - Creates a network target for logging over IPv4 and TCP, but does not open it.
- stumpless_
new_ ⚠tcp6_ target - Creates a network target for logging over IPv6 and TCP, but does not open it.
- stumpless_
new_ ⚠udp4_ target - Creates a network target for logging over IPv4 and UDP, but does not open it.
- stumpless_
new_ ⚠udp6_ target - Creates a network target for logging over IPv6 and UDP, but does not open it.
- stumpless_
open_ ⚠buffer_ target - Creates a buffer target for the given buffer.
- stumpless_
open_ ⚠file_ target - Opens a file target.
- stumpless_
open_ ⚠function_ target - Opens a function target.
- stumpless_
open_ ⚠network_ target - Opens a network target.
- stumpless_
open_ ⚠sqlite3_ target - Opens a SQLite3 target.
- stumpless_
open_ ⚠sqlite3_ target_ from_ db - Opens a SQLite3 target with an already-open database handle.
- stumpless_
open_ ⚠sqlite3_ target_ with_ options - Opens a SQLite3 target with the provided options. The three parameters are passed directly to sqlite3_open_v2.
- stumpless_
open_ ⚠stderr_ target - Opens a stream target for the stderr stream.
- stumpless_
open_ ⚠stdout_ target - Opens a stream target for the stdout stream.
- stumpless_
open_ ⚠stream_ target - Opens a stream target for the given stream.
- stumpless_
open_ ⚠target - Opens a target that has already been created and configured.
- stumpless_
open_ ⚠tcp4_ target - Opens a network target for remote logging over IPv4 and TCP.
- stumpless_
open_ ⚠tcp6_ target - Opens a network target for remote logging over IPv6 and TCP.
- stumpless_
open_ ⚠udp4_ target - Opens a network target for remote logging over IPv4 and UDP.
- stumpless_
open_ ⚠udp6_ target - Opens a network target for remote logging over IPv6 and UDP.
- stumpless_
param_ ⚠to_ string - Returns the name and the value from param as a formatted string. The character buffer should be freed when no longer is needed by the caller.
- stumpless_
perror ⚠ - Prints information about the current error to the error stream.
- stumpless_
prival_ ⚠from_ string - Extract PRIVAL number (Facility and Severity) from the given string with the direct number or with two names divided with a period in the order: facility first, then severity (“<facility_descr>.<severity_descr>”).
- stumpless_
read_ ⚠buffer - Reads the next message from the provided buffer target and writes it into the given buffer.
- stumpless_
set_ ⚠cons_ stream - Sets the console stream to write logs to.
- stumpless_
set_ ⚠current_ target - Sets the target used when one is not provided.
- stumpless_
set_ ⚠default_ facility - Sets the default facility of a target.
- stumpless_
set_ ⚠destination - Sets the destination of a network target.
- stumpless_
set_ ⚠element - Puts the element at the given index in the given entry.
- stumpless_
set_ ⚠element_ name - Sets the name of the given element.
- stumpless_
set_ ⚠entry_ app_ name - Sets the app name for an entry.
- stumpless_
set_ ⚠entry_ facility - Sets the facility of an entry.
- stumpless_
set_ ⚠entry_ hostname - Sets the hostname of a given entry. If hostname is NULL it will set hostname to be the Machine hostname.
- stumpless_
set_ ⚠entry_ message - Sets the message of a given entry.
- stumpless_
set_ ⚠entry_ message_ str - Sets the message of a given entry.
- stumpless_
set_ ⚠entry_ message_ str_ w - Sets the message of a given entry.
- stumpless_
set_ ⚠entry_ msgid - Sets the msgid for an entry.
- stumpless_
set_ ⚠entry_ param_ by_ index - Puts the param in the element at the given index of an entry.
- stumpless_
set_ ⚠entry_ param_ value_ by_ index - Sets the value of the param in the element at the given index of an entry.
- stumpless_
set_ ⚠entry_ param_ value_ by_ name - Sets the value of the first param in the named element an entry.
- stumpless_
set_ ⚠entry_ priority - Sets the facility and severity of an entry.
- stumpless_
set_ ⚠entry_ prival - Sets the prival of an entry, as defined in RFC 5424.
- stumpless_
set_ ⚠entry_ procid - Sets the procid of a given entry. If procid is NULL it will set procid to be the ProcessID.
- stumpless_
set_ ⚠entry_ severity - Sets the severity of an entry.
- stumpless_
set_ ⚠error_ stream - Sets the stream to write errors to.
- stumpless_
set_ ⚠free - Sets the function used by the library to free memory.
- stumpless_
set_ ⚠malloc - Sets the function used by the library to allocate memory.
- stumpless_
set_ ⚠option - Sets an option on a target.
- stumpless_
set_ ⚠param - Puts the param at the given index in the given element.
- stumpless_
set_ ⚠param_ name - Sets the name of the given param.
- stumpless_
set_ ⚠param_ value - Sets the value of the given param.
- stumpless_
set_ ⚠param_ value_ by_ index - Sets the value of the param at the given index in the given element.
- stumpless_
set_ ⚠param_ value_ by_ name - Sets the value of the first param with the given name in the given element.
- stumpless_
set_ ⚠realloc - Sets the function used by the library to reallocate memory.
- stumpless_
set_ ⚠sqlite3_ insert_ sql - Sets the SQL statement used to insert entries into the database.
- stumpless_
set_ ⚠sqlite3_ prepare - Set the function used to prepare statements for entries to this target.
- stumpless_
set_ ⚠target_ default_ app_ name - Sets the default app name for a given target.
- stumpless_
set_ ⚠target_ default_ msgid - Sets the default msgid for a given target.
- stumpless_
set_ ⚠target_ filter - Sets the filter used to determine whether entries should be logged by a given target.
- stumpless_
set_ ⚠target_ mask - Sets the log mask of a target.
- stumpless_
set_ ⚠transport_ port - Sets the transport port number of a network target.
- stumpless_
set_ ⚠udp_ max_ message_ size - Sets the maximum message size of a UDP network target.
- stumpless_
sqlite3_ ⚠prepare - The default prepare function used for SQLite3 targets.
- stumpless_
target_ ⚠is_ open - Checks to see if the given target is open.
- stumpless_
trace_ ⚠entry - Adds an entry into a given target. The entry has a structured data element added to it with the file, line, and function information specified.
- stumpless_
trace_ ⚠log - Adds a log message with a priority to a given target, along with the file, line, and function information specified in a structured data element.
- stumpless_
trace_ ⚠log_ str - Adds a log message with a priority to a given target, along with the file, line, and function information specified in a structured data element.
- stumpless_
trace_ ⚠message - Adds a message to a given target, along with the file, line, and function information specified in a structured data element.
- stumpless_
trace_ ⚠message_ str - Adds a message to a given target, along with the file, line, and function information specified in a structured data element.
- stumpless_
unload_ ⚠element_ and_ contents - Unloads an element as well as all params that it contains.
- stumpless_
unload_ ⚠element_ only - Unloads an element, freeing any allocated memory. Associated params are left untouched, and must be unloaded separately.
- stumpless_
unload_ ⚠entry_ and_ contents - Unloads an entry as well as all elements that it contains.
- stumpless_
unload_ ⚠entry_ only - Unloads an entry, freeing any allocated memory. Associated elements are left untouched, and must be unloaded separately.
- stumpless_
unload_ ⚠param - Unloads a param.
- stumpless_
unset_ ⚠option - Unsets an option on a target.
- stumpless_
version_ ⚠cmp - Compares the version of two given stumpless_version struct.
- stumpless_
version_ ⚠to_ string - Creates a string representation of the given version.
- stumplog⚠
- Logs a message to the current target with the given priority.
- stumplog_
set_ ⚠mask - Sets the log mask of the current target.
- stumplog_
str ⚠ - Logs a message to the current target with the given priority.
- stumplog_
trace ⚠ - Logs a message to the default target with the given priority, along with the file, line, and function information specified in a structured data element.
- stumplog_
trace_ ⚠str - Logs a message to the default target with the given priority, along with the file, line, and function information specified in a structured data element.
Type Aliases§
- FILE
- _IO_
lock_ t - __
off64_ t - __off_t
- stumpless_
error_ id - An (enum) identifier of the types of errors that might be encountered.
- stumpless_
facility - All possible facility codes available to log entries.
- stumpless_
filter_ func_ t - A function that determines whether a given entry should be sent to a given target.
- stumpless_
id_ t - stumpless_
log_ func_ t - A handler for entries sent to a function target.
- stumpless_
network_ protocol - Network protocols used by a network target.
- stumpless_
severity - All possible severity codes available to log entries.
- stumpless_
sqlite3_ prepare_ func_ t - A function for generating SQLite3 prepared statements for a given entry. See \ref stumpless_set_sqlite3_prepare for the semantics of writing and using a prepare function with SQLite3 targets.
- stumpless_
target_ type - Types of targets that may be created.
- stumpless_
transport_ protocol - Transport protocols used by a network target.
- wchar_t