Enum _NVENCSTATUS

#[repr(u32)]
pub enum _NVENCSTATUS {
    NV_ENC_SUCCESS = 0,
    NV_ENC_ERR_NO_ENCODE_DEVICE = 1,
    NV_ENC_ERR_UNSUPPORTED_DEVICE = 2,
    NV_ENC_ERR_INVALID_ENCODERDEVICE = 3,
    NV_ENC_ERR_INVALID_DEVICE = 4,
    NV_ENC_ERR_DEVICE_NOT_EXIST = 5,
    NV_ENC_ERR_INVALID_PTR = 6,
    NV_ENC_ERR_INVALID_EVENT = 7,
    NV_ENC_ERR_INVALID_PARAM = 8,
    NV_ENC_ERR_INVALID_CALL = 9,
    NV_ENC_ERR_OUT_OF_MEMORY = 10,
    NV_ENC_ERR_ENCODER_NOT_INITIALIZED = 11,
    NV_ENC_ERR_UNSUPPORTED_PARAM = 12,
    NV_ENC_ERR_LOCK_BUSY = 13,
    NV_ENC_ERR_NOT_ENOUGH_BUFFER = 14,
    NV_ENC_ERR_INVALID_VERSION = 15,
    NV_ENC_ERR_MAP_FAILED = 16,
    NV_ENC_ERR_NEED_MORE_INPUT = 17,
    NV_ENC_ERR_ENCODER_BUSY = 18,
    NV_ENC_ERR_EVENT_NOT_REGISTERD = 19,
    NV_ENC_ERR_GENERIC = 20,
    NV_ENC_ERR_INCOMPATIBLE_CLIENT_KEY = 21,
    NV_ENC_ERR_UNIMPLEMENTED = 22,
    NV_ENC_ERR_RESOURCE_REGISTER_FAILED = 23,
    NV_ENC_ERR_RESOURCE_NOT_REGISTERED = 24,
    NV_ENC_ERR_RESOURCE_NOT_MAPPED = 25,
    NV_ENC_ERR_NEED_MORE_OUTPUT = 26,
}

Variants

NV_ENC_SUCCESS = 0

NV_ENC_ERR_NO_ENCODE_DEVICE = 1

NV_ENC_ERR_UNSUPPORTED_DEVICE = 2

NV_ENC_ERR_INVALID_ENCODERDEVICE = 3

NV_ENC_ERR_INVALID_DEVICE = 4

NV_ENC_ERR_DEVICE_NOT_EXIST = 5

NV_ENC_ERR_INVALID_PTR = 6

NV_ENC_ERR_INVALID_EVENT = 7

NV_ENC_ERR_INVALID_PARAM = 8

NV_ENC_ERR_INVALID_CALL = 9

NV_ENC_ERR_OUT_OF_MEMORY = 10

NV_ENC_ERR_ENCODER_NOT_INITIALIZED = 11

NV_ENC_ERR_UNSUPPORTED_PARAM = 12

NV_ENC_ERR_LOCK_BUSY = 13

NV_ENC_ERR_NOT_ENOUGH_BUFFER = 14

NV_ENC_ERR_INVALID_VERSION = 15

NV_ENC_ERR_MAP_FAILED = 16

NV_ENC_ERR_NEED_MORE_INPUT = 17

NV_ENC_ERR_ENCODER_BUSY = 18

NV_ENC_ERR_EVENT_NOT_REGISTERD = 19

NV_ENC_ERR_GENERIC = 20

NV_ENC_ERR_INCOMPATIBLE_CLIENT_KEY = 21

NV_ENC_ERR_UNIMPLEMENTED = 22

NV_ENC_ERR_RESOURCE_REGISTER_FAILED = 23

NV_ENC_ERR_RESOURCE_NOT_REGISTERED = 24

NV_ENC_ERR_RESOURCE_NOT_MAPPED = 25

NV_ENC_ERR_NEED_MORE_OUTPUT = 26

Implementations

impl NVENCSTATUS

pub fn result(self, encoder: &Encoder) -> Result<(), EncodeError>

Convert an NVENCSTATUS to a Result.

NVENCSTATUS::NV_ENC_SUCCESS is converted to Ok(()), and all other variants are mapped to the corresponding variant in ErrorKind. The error type is EncodeError which has a kind and an optional String which might contain additional information about the error.

Errors

Returns an error whenever the status is not NVENCSTATUS::NV_ENC_SUCCESS.

Examples

let encoder = Encoder::initialize_with_cuda(cuda_device).unwrap();
// Cause an error by passing in an invalid GUID.
// `Encoder::get_supported_input_formats()` uses `.result()` internally
let error = encoder
    .get_supported_input_formats(GUID::default())
    .unwrap_err();
// Get the kind.
assert_eq!(error.kind(), ErrorKind::InvalidParam);
// Get the error message.
// Unfortunately, it's not always helpful.
assert_eq!(error.string(), Some("EncodeAPI Internal Error."));

pub fn result_without_string(self) -> Result<(), EncodeError>

Convert an NVENCSTATUS to a Result without using an Encoder.

This function is the same as NVENCSTATUS::result except it does not get the error string because it does not have access to an Encoder. This is only useful if you do not have an Encoder yet, for example when initializing the API.

You should always prefer to use NVENCSTATUS::result when possible.

Errors

Returns an error whenever the status is not NVENCSTATUS::NV_ENC_SUCCESS.

Trait Implementations

impl Clone for _NVENCSTATUS

fn clone(&self) -> _NVENCSTATUS

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for _NVENCSTATUS

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

Formats the value using the given formatter.

impl From<_NVENCSTATUS> for ErrorKind

fn from(status: NVENCSTATUS) -> Self

Converts to this type from the input type.

impl Hash for _NVENCSTATUS

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for _NVENCSTATUS

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for _NVENCSTATUS

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for _NVENCSTATUS

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for _NVENCSTATUS

impl Eq for _NVENCSTATUS

impl StructuralPartialEq for _NVENCSTATUS