Enum EncoderStateError

#[non_exhaustive]
pub enum EncoderStateError {
    Invalid,
    Ended,
    Locked,
    Unlocked,
    Submitted,
}

Errors related to the state of a command or pass encoder.

The exact behavior of these errors may change based on the resolution of https://github.com/gpuweb/gpuweb/issues/5207.

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.

Invalid

Used internally by wgpu functions to indicate the encoder already contained an error. This variant should usually not be seen by users of the API, since an effort should be made to provide the caller with a more specific reason for the encoder being invalid.

Ended

Returned immediately when an attempt is made to encode a command using an encoder that has already finished.

Locked

Returned by a subsequent call to encoder.finish(), if there was an attempt to open a second pass on the encoder while it was locked for a first pass (i.e. the first pass was still open).

Note: only command encoders can be locked (not pass encoders).

Unlocked

Returned when attempting to end a pass if the parent encoder is not locked. This can only happen if pass begin/end calls are mismatched.

Submitted

The command buffer has already been submitted.

Although command encoders and command buffers are distinct WebGPU objects, we use CommandEncoderStatus for both.

Trait Implementations

impl Clone for EncoderStateError

fn clone(&self) -> EncoderStateError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncoderStateError

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

Formats the value using the given formatter.

impl Display for EncoderStateError

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

Formats the value using the given formatter.

impl Error for EncoderStateError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<EncoderStateError> for BuildAccelerationStructureError

fn from(source: EncoderStateError) -> Self

Converts to this type from the input type.

impl From<EncoderStateError> for ClearError

fn from(source: EncoderStateError) -> Self

Converts to this type from the input type.

impl From<EncoderStateError> for CommandEncoderError

fn from(source: EncoderStateError) -> Self

Converts to this type from the input type.

impl From<EncoderStateError> for CompactBlasError

fn from(source: EncoderStateError) -> Self

Converts to this type from the input type.

impl From<EncoderStateError> for ComputePassErrorInner

fn from(source: EncoderStateError) -> Self

Converts to this type from the input type.

impl From<EncoderStateError> for QueryError

fn from(source: EncoderStateError) -> Self

Converts to this type from the input type.

impl From<EncoderStateError> for RenderPassErrorInner

fn from(source: EncoderStateError) -> Self

Converts to this type from the input type.

impl WebGpuError for EncoderStateError

fn webgpu_error_type(&self) -> ErrorType

Determine the classification of this error as a WebGPU ErrorType.