Enum gstreamer::DebugLevel

#[non_exhaustive]
pub enum DebugLevel {
    None,
    Error,
    Warning,
    Fixme,
    Info,
    Debug,
    Log,
    Trace,
    Memdump,
    Count,
    // some variants omitted
}

The level defines the importance of a debugging message. The more important a message is, the greater the probability that the debugging system outputs it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

No debugging level specified or desired. Used to deactivate debugging output.

Error

Error messages are to be used only when an error occurred that stops the application from keeping working correctly. An examples is gst_element_error, which outputs a message with this priority. It does not mean that the application is terminating as with g_error.

Warning

Warning messages are to inform about abnormal behaviour that could lead to problems or weird behaviour later on. An example of this would be clocking issues (“your computer is pretty slow”) or broken input data (“Can’t synchronize to stream.”)

Fixme

Fixme messages are messages that indicate that something in the executed code path is not fully implemented or handled yet. Note that this does not replace proper error handling in any way, the purpose of this message is to make it easier to spot incomplete/unfinished pieces of code when reading the debug log.

Info

Informational messages should be used to keep the developer updated about what is happening. Examples where this should be used are when a typefind function has successfully determined the type of the stream or when an mp3 plugin detects the format to be used. (“This file has mono sound.”)

Debug

Debugging messages should be used when something common happens that is not the expected default behavior, or something that’s useful to know but doesn’t happen all the time (ie. per loop iteration or buffer processed or event handled). An example would be notifications about state changes or receiving/sending of events.

Log

Log messages are messages that are very common but might be useful to know. As a rule of thumb a pipeline that is running as expected should never output anything else but LOG messages whilst processing data. Use this log level to log recurring information in chain functions and loop functions, for example.

Trace

Tracing-related messages. Examples for this are referencing/dereferencing of objects.

Memdump

memory dump messages are used to log (small) chunks of data as memory dumps in the log. They will be displayed as hexdump with ASCII characters.

Count

The number of defined debugging levels.

Implementations

impl DebugLevel

pub fn name<'a>(self) -> &'a str

Trait Implementations

impl Clone for DebugLevel

fn clone(&self) -> DebugLevel

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DebugLevel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DebugLevel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> FromValue<'a> for DebugLevel

type Checker = GenericValueTypeChecker<Self>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl Hash for DebugLevel

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for DebugLevel

fn cmp(&self, other: &DebugLevel) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DebugLevel> for DebugLevel

fn eq(&self, other: &DebugLevel) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DebugLevel) -> bool

This method tests for !=.

impl PartialOrd<DebugLevel> for DebugLevel

fn partial_cmp(&self, other: &DebugLevel) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DebugLevel

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for DebugLevel

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ValueType for DebugLevel

type Type = Self

Type to get the Type from.

impl Copy for DebugLevel

impl Eq for DebugLevel

impl StructuralEq for DebugLevel

impl StructuralPartialEq for DebugLevel