pub struct IErrorRecorder { /* private fields */ }Implementations§
Source§impl IErrorRecorder
impl IErrorRecorder
Sourcepub fn getInterfaceInfo<'a>(
self: &'a IErrorRecorder,
) -> impl New<Output = InterfaceInfo> + 'a
pub fn getInterfaceInfo<'a>( self: &'a IErrorRecorder, ) -> impl New<Output = InterfaceInfo> + 'a
Return version information associated with this interface. Applications must not override this method.
Sourcepub fn getNbErrors(self: &IErrorRecorder) -> i32
pub fn getNbErrors(self: &IErrorRecorder) -> i32
Return the number of errors
Determines the number of errors that occurred between the current point in execution and the last time that the clear() was executed. Due to the possibility of asynchronous errors occurring, a TensorRT API can return correct results, but still register errors with the Error Recorder. The value of getNbErrors() must increment by 1 after each reportError() call until clear() is called, or the maximum number of errors that can be stored is exceeded.
Returns the number of errors detected, or 0 if there are no errors. If the upper bound of errors that can be stored is exceeded, the upper bound value must be returned.
For example, if the error recorder can store up to 16 error descriptions but reportError() has been called 20 times, getNbErrors() must return 16.
See [clear()], hasOverflowed()
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.
Sourcepub fn getErrorCode(self: &IErrorRecorder, errorIdx: i32) -> i32
pub fn getErrorCode(self: &IErrorRecorder, errorIdx: i32) -> i32
Returns the ErrorCode enumeration.
errorIdxA 32-bit integer that indexes into the error array.
The errorIdx specifies what error code from 0 to getNbErrors()-1 that the application wants to analyze and return the error code enum.
Returns the enum corresponding to errorIdx if errorIdx is in range (between 0 and getNbErrors()-1). ErrorCode::kUNSPECIFIED_ERROR must be returned if errorIdx is not in range.
See [getErrorDesc()], ErrorCode
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.
Sourcepub fn getErrorDesc(self: &IErrorRecorder, errorIdx: i32) -> *const c_char
pub fn getErrorDesc(self: &IErrorRecorder, errorIdx: i32) -> *const c_char
Returns a null-terminated C-style string description of the error.
errorIdxA 32-bit integer that indexes into the error array.
For the error specified by the idx value, return the string description of the error. The
error string is a null-terminated C-style string. In the safety context there is a
constant length requirement to remove any dynamic memory allocations and the error message
will be truncated if it exceeds kMAX_DESC_LENGTH bytes.
The format of the string is “
Returns a string representation of the error along with a description of the error if errorIdx is in range (between 0 and getNbErrors()-1). An empty string will be returned if errorIdx is not in range.
See [getErrorCode()]
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.
Sourcepub fn hasOverflowed(self: &IErrorRecorder) -> bool
pub fn hasOverflowed(self: &IErrorRecorder) -> bool
Determine if the error stack has overflowed.
In the case when the number of errors is large, this function is used to query if one or more errors have been dropped due to lack of storage capacity. This is especially important in the automotive safety case where the internal error handling mechanisms cannot allocate memory.
true if errors have been dropped due to overflowing the error stack.
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.
Sourcepub fn clear(self: Pin<&mut IErrorRecorder>)
pub fn clear(self: Pin<&mut IErrorRecorder>)
Clear the error stack on the error recorder.
Removes all the tracked errors by the error recorder. The implementation must guarantee that after this function is called, and as long as no error occurs, the next call to getNbErrors will return zero and hasOverflowed will return false.
See [getNbErrors()], hasOverflowed()
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.
Sourcepub unsafe fn reportError(
self: Pin<&mut IErrorRecorder>,
val: i32,
desc: *const c_char,
) -> bool
pub unsafe fn reportError( self: Pin<&mut IErrorRecorder>, val: i32, desc: *const c_char, ) -> bool
Report an error to the error recorder with the corresponding enum and description.
valThe error code enum that is being reported.descThe string description of the error, which will be a NULL-terminated string. For safety use cases its length is limited to kMAX_DESC_LENGTH bytes (excluding the NULL terminator) and descriptions that exceed this limit will be silently truncated.
Report an error to the user that has a given value and human readable description. The function returns false if processing can continue, which implies that the reported error is not fatal. This does not guarantee that processing continues, but provides a hint to TensorRT. The desc C-string data is only valid during the call to reportError and may be immediately deallocated by the caller when reportError returns. The implementation must not store the desc pointer in the ErrorRecorder object or otherwise access the data from desc after reportError returns.
True if the error is determined to be fatal and processing of the current function must end.
If the error recorder’s maximum number of storable errors is exceeded, the error description will be silently dropped and the value returned by getNbErrors() will not be incremented. However, the return value will still signal whether the error must be considered fatal.
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.
Sourcepub fn incRefCount(self: Pin<&mut IErrorRecorder>) -> i32
pub fn incRefCount(self: Pin<&mut IErrorRecorder>) -> i32
Increments the refcount for the current ErrorRecorder.
Increments the reference count for the object by one and returns the current value. This reference count allows the application to know that an object inside of TensorRT has taken a reference to the ErrorRecorder. TensorRT guarantees that every call to IErrorRecorder::incRefCount() will be paired with a call to IErrorRecorder::decRefCount() when the reference is released. It is undefined behavior to destruct the ErrorRecorder when incRefCount() has been called without a corresponding decRefCount().
The reference counted value after the increment completes.
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.
Sourcepub fn decRefCount(self: Pin<&mut IErrorRecorder>) -> i32
pub fn decRefCount(self: Pin<&mut IErrorRecorder>) -> i32
Decrements the refcount for the current ErrorRecorder.
Decrements the reference count for the object by one and returns the current value. This reference count allows the application to know that an object inside of TensorRT has taken a reference to the ErrorRecorder. TensorRT guarantees that every call to IErrorRecorder::decRefCount() will be preceded by a call to IErrorRecorder::incRefCount(). It is undefined behavior to destruct the ErrorRecorder when incRefCount() has been called without a corresponding decRefCount().
The reference counted value after the decrement completes.
- Allowed context for the API call
- Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.