Struct Features

pub struct Features(/* private fields */);

Features that are not guaranteed to be supported.

These are either part of the webgpu standard, or are extension features supported by wgpu when targeting native.

If you want to use a feature, you need to first verify that the adapter supports the feature. If the adapter does not support the feature, requesting a device with it enabled will panic.

Corresponds to WebGPU GPUFeatureName.

Implementations

impl Features

pub const DEPTH_CLIP_CONTROL: Self = _

By default, polygon depth is clipped to 0-1 range before/during rasterization. Anything outside of that range is rejected, and respective fragments are not touched.

With this extension, we can disabling clipping. That allows shadow map occluders to be rendered into a tighter depth range.

Supported platforms:

• desktops
• some mobile chips

This is a web and native feature.

pub const DEPTH32FLOAT_STENCIL8: Self = _

Allows for explicit creation of textures of format TextureFormat::Depth32FloatStencil8

Supported platforms:

• Vulkan (mostly)
• DX12
• Metal
• OpenGL

This is a web and native feature.

pub const TEXTURE_COMPRESSION_BC: Self = _

Enables BCn family of compressed textures. All BCn textures use 4x4 pixel blocks with 8 or 16 bytes per block.

Compressed textures sacrifice some quality in exchange for significantly reduced bandwidth usage.

Support for this feature guarantees availability of [TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING] for BCn formats. Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES may enable additional usages.

This feature guarantees availability of sliced-3d textures for BC formats when combined with TEXTURE_COMPRESSION_BC_SLICED_3D.

Supported Platforms:

• desktops
• Mobile (All Apple9 and some Apple7 and Apple8 devices)

This is a web and native feature.

pub const TEXTURE_COMPRESSION_BC_SLICED_3D: Self = _

Allows the 3d dimension for textures with BC compressed formats.

This feature must be used in combination with TEXTURE_COMPRESSION_BC to enable 3D textures with BC compression. It does not enable the BC formats by itself.

Supported Platforms:

• desktops
• Mobile (All Apple9 and some Apple7 and Apple8 devices)

This is a web and native feature.

pub const TEXTURE_COMPRESSION_ETC2: Self = _

Enables ETC family of compressed textures. All ETC textures use 4x4 pixel blocks. ETC2 RGB and RGBA1 are 8 bytes per block. RTC2 RGBA8 and EAC are 16 bytes per block.

Compressed textures sacrifice some quality in exchange for significantly reduced bandwidth usage.

Support for this feature guarantees availability of [TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING] for ETC2 formats. Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES may enable additional usages.

Supported Platforms:

• Vulkan on Intel
• Mobile (some)

This is a web and native feature.

pub const TEXTURE_COMPRESSION_ASTC: Self = _

Enables ASTC family of compressed textures. ASTC textures use pixel blocks varying from 4x4 to 12x12. Blocks are always 16 bytes.

Compressed textures sacrifice some quality in exchange for significantly reduced bandwidth usage.

Support for this feature guarantees availability of [TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING] for ASTC formats with Unorm/UnormSrgb channel type. Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES may enable additional usages.

Supported Platforms:

• Vulkan on Intel
• Mobile (some)

This is a web and native feature.

pub const TIMESTAMP_QUERY: Self = _

Enables use of Timestamp Queries. These queries tell the current gpu timestamp when all work before the query is finished.

This feature allows the use of

• [RenderPassDescriptor::timestamp_writes]
• [ComputePassDescriptor::timestamp_writes] to write out timestamps.

For arbitrary timestamp write commands on encoders refer to Features::TIMESTAMP_QUERY_INSIDE_ENCODERS. For arbitrary timestamp write commands on passes refer to Features::TIMESTAMP_QUERY_INSIDE_PASSES.

They must be resolved using [CommandEncoder::resolve_query_set] into a buffer, then the result must be multiplied by the timestamp period [Queue::get_timestamp_period] to get the timestamp in nanoseconds. Multiple timestamps can then be diffed to get the time for operations between them to finish.

Supported Platforms:

• Vulkan
• DX12
• Metal

This is a web and native feature.

pub const INDIRECT_FIRST_INSTANCE: Self = _

Allows non-zero value for the first_instance member in indirect draw calls.

If this feature is not enabled, and the first_instance member is non-zero, the behavior may be:

• The draw call is ignored.
• The draw call is executed as if the first_instance is zero.
• The draw call is executed with the correct first_instance value.

Supported Platforms:

• Vulkan (mostly)
• DX12
• Metal on Apple3+ or Mac1+
• OpenGL (Desktop 4.2+ with ARB_shader_draw_parameters only)

Not Supported:

• OpenGL ES / WebGL

This is a web and native feature.

pub const SHADER_F16: Self = _

Allows shaders to acquire the FP16 ability

Note: this is not supported in naga yet, only through spirv-passthrough right now.

Supported Platforms:

• Vulkan
• Metal

This is a web and native feature.

pub const RG11B10UFLOAT_RENDERABLE: Self = _

Allows for usage of textures of format TextureFormat::Rg11b10Ufloat as a render target

Supported platforms:

• Vulkan
• DX12
• Metal

This is a web and native feature.

pub const BGRA8UNORM_STORAGE: Self = _

Allows the [wgpu::TextureUsages::STORAGE_BINDING] usage on textures with format [TextureFormat::Bgra8unorm]

Supported Platforms:

• Vulkan
• DX12
• Metal

This is a web and native feature.

pub const FLOAT32_FILTERABLE: Self = _

Allows textures with formats “r32float”, “rg32float”, and “rgba32float” to be filterable.

Supported Platforms:

• Vulkan (mainly on Desktop GPUs)
• DX12
• Metal on macOS or Apple9+ GPUs, optional on iOS/iPadOS with Apple7/8 GPUs
• GL with one of GL_ARB_color_buffer_float/GL_EXT_color_buffer_float/OES_texture_float_linear

This is a web and native feature.

pub const TEXTURE_FORMAT_16BIT_NORM: Self = _

Enables normalized 16-bit texture formats.

Supported platforms:

• Vulkan
• DX12
• Metal

This is a native only feature.

pub const TEXTURE_COMPRESSION_ASTC_HDR: Self = _

Enables ASTC HDR family of compressed textures.

Compressed textures sacrifice some quality in exchange for significantly reduced bandwidth usage.

Support for this feature guarantees availability of [TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING] for ASTC formats with the HDR channel type. Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES may enable additional usages.

Supported Platforms:

• Metal
• Vulkan
• OpenGL

This is a native only feature.

pub const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES: Self = _

Enables device specific texture format features.

See TextureFormatFeatures for a listing of the features in question.

By default only texture format properties as defined by the WebGPU specification are allowed. Enabling this feature flag extends the features of each format to the ones supported by the current device. Note that without this flag, read/write storage access is not allowed at all.

This extension does not enable additional formats.

This is a native only feature.

pub const PIPELINE_STATISTICS_QUERY: Self = _

Enables use of Pipeline Statistics Queries. These queries tell the count of various operations performed between the start and stop call. Call [RenderPass::begin_pipeline_statistics_query] to start a query, then call [RenderPass::end_pipeline_statistics_query] to stop one.

They must be resolved using [CommandEncoder::resolve_query_set] into a buffer. The rules on how these resolve into buffers are detailed in the documentation for PipelineStatisticsTypes.

Supported Platforms:

• Vulkan
• DX12

This is a native only feature with a proposal for the web.

pub const TIMESTAMP_QUERY_INSIDE_ENCODERS: Self = _

Allows for timestamp queries directly on command encoders.

Implies Features::TIMESTAMP_QUERY is supported.

Additionally allows for timestamp writes on command encoders using [CommandEncoder::write_timestamp].

Supported platforms:

• Vulkan
• DX12
• Metal

This is a native only feature.

pub const TIMESTAMP_QUERY_INSIDE_PASSES: Self = _

Allows for timestamp queries directly on command encoders.

Implies Features::TIMESTAMP_QUERY & Features::TIMESTAMP_QUERY_INSIDE_ENCODERS is supported.

Additionally allows for timestamp queries to be used inside render & compute passes using:

• [RenderPass::write_timestamp]
• [ComputePass::write_timestamp]

Supported platforms:

• Vulkan
• DX12
• Metal (AMD & Intel, not Apple GPUs)

This is generally not available on tile-based rasterization GPUs.

This is a native only feature with a proposal for the web.

pub const MAPPABLE_PRIMARY_BUFFERS: Self = _

Webgpu only allows the MAP_READ and MAP_WRITE buffer usage to be matched with COPY_DST and COPY_SRC respectively. This removes this requirement.

This is only beneficial on systems that share memory between CPU and GPU. If enabled on a system that doesn’t, this can severely hinder performance. Only use if you understand the consequences.

Supported platforms:

• Vulkan
• DX12
• Metal

This is a native only feature.

pub const TEXTURE_BINDING_ARRAY: Self = _

Allows the user to create uniform arrays of textures in shaders:

ex.

• var textures: binding_array<texture_2d<f32>, 10> (WGSL)
• uniform texture2D textures[10] (GLSL)

If Features::STORAGE_RESOURCE_BINDING_ARRAY is supported as well as this, the user may also create uniform arrays of storage textures.

ex.

• var textures: array<texture_storage_2d<r32float, write>, 10> (WGSL)
• uniform image2D textures[10] (GLSL)

This capability allows them to exist and to be indexed by dynamically uniform values.

Supported platforms:

• DX12
• Metal (with MSL 2.0+ on macOS 10.13+)
• Vulkan

This is a native only feature.

pub const BUFFER_BINDING_ARRAY: Self = _

Allows the user to create arrays of buffers in shaders:

ex.

• var<uniform> buffer_array: array<MyBuffer, 10> (WGSL)
• uniform myBuffer { ... } buffer_array[10] (GLSL)

This capability allows them to exist and to be indexed by dynamically uniform values.

If Features::STORAGE_RESOURCE_BINDING_ARRAY is supported as well as this, the user may also create arrays of storage buffers.

ex.

• var<storage> buffer_array: array<MyBuffer, 10> (WGSL)
• buffer myBuffer { ... } buffer_array[10] (GLSL)

Supported platforms:

• DX12
• Vulkan

This is a native only feature.

pub const STORAGE_RESOURCE_BINDING_ARRAY: Self = _

Allows the user to create uniform arrays of storage buffers or textures in shaders, if resp. Features::BUFFER_BINDING_ARRAY or Features::TEXTURE_BINDING_ARRAY is supported.

This capability allows them to exist and to be indexed by dynamically uniform values.

Supported platforms:

• Metal (with MSL 2.2+ on macOS 10.13+)
• Vulkan

This is a native only feature.

pub const SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING: Self = _

Allows shaders to index sampled texture and storage buffer resource arrays with dynamically non-uniform values:

ex. texture_array[vertex_data]

In order to use this capability, the corresponding GLSL extension must be enabled like so:

#extension GL_EXT_nonuniform_qualifier : require

and then used either as nonuniformEXT qualifier in variable declaration:

ex. layout(location = 0) nonuniformEXT flat in int vertex_data;

or as nonuniformEXT constructor:

ex. texture_array[nonuniformEXT(vertex_data)]

WGSL and HLSL do not need any extension.

Supported platforms:

• DX12
• Metal (with MSL 2.0+ on macOS 10.13+)
• Vulkan 1.2+ (or VK_EXT_descriptor_indexing)’s shaderSampledImageArrayNonUniformIndexing & shaderStorageBufferArrayNonUniformIndexing feature)

This is a native only feature.

pub const UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING: Self = _

Allows shaders to index uniform buffer and storage texture resource arrays with dynamically non-uniform values:

ex. texture_array[vertex_data]

In order to use this capability, the corresponding GLSL extension must be enabled like so:

#extension GL_EXT_nonuniform_qualifier : require

and then used either as nonuniformEXT qualifier in variable declaration:

ex. layout(location = 0) nonuniformEXT flat in int vertex_data;

or as nonuniformEXT constructor:

ex. texture_array[nonuniformEXT(vertex_data)]

WGSL and HLSL do not need any extension.

Supported platforms:

• DX12
• Metal (with MSL 2.0+ on macOS 10.13+)
• Vulkan 1.2+ (or VK_EXT_descriptor_indexing)’s shaderUniformBufferArrayNonUniformIndexing & shaderStorageTextureArrayNonUniformIndexing feature)

This is a native only feature.

pub const PARTIALLY_BOUND_BINDING_ARRAY: Self = _

Allows the user to create bind groups containing arrays with less bindings than the BindGroupLayout.

This is a native only feature.

pub const MULTI_DRAW_INDIRECT: Self = _

Allows the user to call RenderPass::multi_draw_indirect and RenderPass::multi_draw_indexed_indirect.

Allows multiple indirect calls to be dispatched from a single buffer.

Supported platforms:

• DX12
• Vulkan
• Metal on Apple3+ or Mac1+ (Emulated on top of draw_indirect and draw_indexed_indirect)

This is a native only feature.

pub const MULTI_DRAW_INDIRECT_COUNT: Self = _

Allows the user to call RenderPass::multi_draw_indirect_count and RenderPass::multi_draw_indexed_indirect_count.

This allows the use of a buffer containing the actual number of draw calls.

Supported platforms:

• DX12
• Vulkan 1.2+ (or VK_KHR_draw_indirect_count)

This is a native only feature.

pub const PUSH_CONSTANTS: Self = _

Allows the use of push constants: small, fast bits of memory that can be updated inside a RenderPass.

Allows the user to call RenderPass::set_push_constants, provide a non-empty array to PipelineLayoutDescriptor, and provide a non-zero limit to Limits::max_push_constant_size.

A block of push constants can be declared in WGSL with var<push_constant>:

struct PushConstants { example: f32, }
var<push_constant> c: PushConstants;

In GLSL, this corresponds to layout(push_constant) uniform Name {..}.

Supported platforms:

• DX12
• Vulkan
• Metal
• OpenGL (emulated with uniforms)

This is a native only feature.

pub const ADDRESS_MODE_CLAMP_TO_ZERO: Self = _

Allows the use of AddressMode::ClampToBorder with a border color of SamplerBorderColor::Zero.

Supported platforms:

• DX12
• Vulkan
• Metal
• OpenGL

This is a native only feature.

pub const ADDRESS_MODE_CLAMP_TO_BORDER: Self = _

Allows the use of AddressMode::ClampToBorder with a border color other than SamplerBorderColor::Zero.

Supported platforms:

• DX12
• Vulkan
• Metal (macOS 10.12+ only)
• OpenGL

This is a native only feature.

pub const POLYGON_MODE_LINE: Self = _

Allows the user to set PolygonMode::Line in PrimitiveState::polygon_mode

This allows drawing polygons/triangles as lines (wireframe) instead of filled

Supported platforms:

• DX12
• Vulkan
• Metal

This is a native only feature.

pub const POLYGON_MODE_POINT: Self = _

Allows the user to set PolygonMode::Point in PrimitiveState::polygon_mode

This allows only drawing the vertices of polygons/triangles instead of filled

Supported platforms:

• Vulkan

This is a native only feature.

pub const CONSERVATIVE_RASTERIZATION: Self = _

Allows the user to set a overestimation-conservative-rasterization in PrimitiveState::conservative

Processing of degenerate triangles/lines is hardware specific. Only triangles are supported.

Supported platforms:

• Vulkan

This is a native only feature.

pub const VERTEX_WRITABLE_STORAGE: Self = _

Enables bindings of writable storage buffers and textures visible to vertex shaders.

Note: some (tiled-based) platforms do not support vertex shaders with any side-effects.

Supported Platforms:

• All

This is a native only feature.

pub const CLEAR_TEXTURE: Self = _

Enables clear to zero for textures.

Supported platforms:

• All

This is a native only feature.

pub const SPIRV_SHADER_PASSTHROUGH: Self = _

Enables creating shader modules from SPIR-V binary data (unsafe).

SPIR-V data is not parsed or interpreted in any way; you can use [wgpu::make_spirv_raw!] to check for alignment and magic number when converting from raw bytes.

Supported platforms:

• Vulkan, in case shader’s requested capabilities and extensions agree with Vulkan implementation.

This is a native only feature.

pub const MULTIVIEW: Self = _

Enables multiview render passes and builtin(view_index) in vertex shaders.

Supported platforms:

• Vulkan
• OpenGL (web only)

This is a native only feature.

pub const VERTEX_ATTRIBUTE_64BIT: Self = _

Enables using 64-bit types for vertex attributes.

Requires SHADER_FLOAT64.

Supported Platforms: N/A

This is a native only feature.

pub const TEXTURE_FORMAT_NV12: Self = _

Allows for creation of textures of format TextureFormat::NV12

Supported platforms:

• DX12
• Vulkan

This is a native only feature.

pub const RAY_TRACING_ACCELERATION_STRUCTURE: Self = _

Allows for the creation of ray-tracing acceleration structures.

Supported platforms:

• Vulkan

This is a native-only feature.

pub const RAY_QUERY: Self = _

Allows for the creation of ray-tracing queries within shaders.

Supported platforms:

• Vulkan

This is a native-only feature.

pub const SHADER_F64: Self = _

Enables 64-bit floating point types in SPIR-V shaders.

Note: even when supported by GPU hardware, 64-bit floating point operations are frequently between 16 and 64 times slower than equivalent operations on 32-bit floats.

Supported Platforms:

• Vulkan

This is a native only feature.

pub const SHADER_I16: Self = _

Allows shaders to use i16. Not currently supported in naga, only available through spirv-passthrough.

Supported platforms:

• Vulkan

This is a native only feature.

pub const SHADER_PRIMITIVE_INDEX: Self = _

Enables builtin(primitive_index) in fragment shaders.

Note: enables geometry processing for pipelines using the builtin. This may come with a significant performance impact on some hardware. Other pipelines are not affected.

Supported platforms:

• Vulkan
• DX12
• Metal (some)
• OpenGL (some)

This is a native only feature.

pub const SHADER_EARLY_DEPTH_TEST: Self = _

Allows shaders to use the early_depth_test attribute.

Supported platforms:

• GLES 3.1+

This is a native only feature.

pub const DUAL_SOURCE_BLENDING: Self = _

Allows two outputs from a shader to be used for blending. Note that dual-source blending doesn’t support multiple render targets.

For more info see the OpenGL ES extension GL_EXT_blend_func_extended.

Supported platforms:

• OpenGL ES (with GL_EXT_blend_func_extended)
• Metal (with MSL 1.2+)
• Vulkan (with dualSrcBlend)
• DX12

pub const SHADER_INT64: Self = _

Allows shaders to use i64 and u64.

Supported platforms:

• Vulkan
• DX12 (DXC only)
• Metal (with MSL 2.3+)

This is a native only feature.

pub const SUBGROUP: Self = _

Allows compute and fragment shaders to use the subgroup operation built-ins

Supported Platforms:

• Vulkan
• DX12
• Metal

This is a native only feature.

pub const SUBGROUP_VERTEX: Self = _

Allows vertex shaders to use the subgroup operation built-ins

Supported Platforms:

• Vulkan

This is a native only feature.

pub const SUBGROUP_BARRIER: Self = _

Allows shaders to use the subgroup barrier

Supported Platforms:

• Vulkan
• Metal

This is a native only feature.

pub const PIPELINE_CACHE: Self = _

Allows the use of pipeline cache objects

Supported platforms:

• Vulkan

Unimplemented Platforms:

• DX12
• Metal

pub const SHADER_INT64_ATOMIC_MIN_MAX: Self = _

Allows shaders to use i64 and u64 atomic min and max.

Supported platforms:

• Vulkan (with VK_KHR_shader_atomic_int64)
• DX12 (with SM 6.6+)
• Metal (with MSL 2.4+)

This is a native only feature.

pub const SHADER_INT64_ATOMIC_ALL_OPS: Self = _

Allows shaders to use all i64 and u64 atomic operations.

Supported platforms:

• Vulkan (with VK_KHR_shader_atomic_int64)
• DX12 (with SM 6.6+)

This is a native only feature.

pub const VULKAN_GOOGLE_DISPLAY_TIMING: Self = _

Allows using the VK_GOOGLE_display_timing Vulkan extension.

This is used for frame pacing to reduce latency, and is generally only available on Android.

This feature does not have a wgpu-level API, and so users of wgpu wishing to use this functionality must access it using various as_hal functions, primarily Surface::as_hal(), to then use.

Supported platforms:

• Vulkan (with VK_GOOGLE_display_timing)

This is a native only feature.

impl Features

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Features

pub const fn iter(&self) -> Iter<Features>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Features>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl Features

pub fn contains_invalid_bits(&self) -> bool

Returns true if the bitflags contains bits that are not part of the bitflags definition.

impl Features

pub const fn all_webgpu_mask() -> Self

Mask of all features which are part of the upstream WebGPU standard.

pub const fn all_native_mask() -> Self

Mask of all features that are only available when targeting native (not web).

Trait Implementations

impl Binary for Features

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

Formats the value using the given formatter.

impl BitAnd for Features

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

The bitwise and (&) of the bits in two flags values.

type Output = Features

The resulting type after applying the & operator.

impl BitAndAssign for Features

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Features

fn bitor(self, other: Features) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = Features

The resulting type after applying the | operator.

impl BitOrAssign for Features

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Features

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Features

The resulting type after applying the ^ operator.

impl BitXorAssign for Features

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for Features

fn clone(&self) -> Features

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Features

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

Formats the value using the given formatter.

impl Default for Features

fn default() -> Features

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Features

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Features, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<Features> for Features

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for Features

const FLAGS: &'static [Flag<Features>] = _

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> Features

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Features> for Features

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for Features

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 IntoIterator for Features

type Item = Features

The type of the elements being iterated over.

type IntoIter = Iter<Features>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Features

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

Formats the value using the given formatter.

impl Not for Features

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Features

The resulting type after applying the ! operator.

impl Octal for Features

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

Formats the value using the given formatter.

impl PartialEq for Features

fn eq(&self, other: &Features) -> 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 PublicFlags for Features

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Serialize for Features

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Features

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Features

The resulting type after applying the - operator.

impl SubAssign for Features

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Features

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

Formats the value using the given formatter.

impl Copy for Features

impl Eq for Features

impl StructuralPartialEq for Features