Struct hyperscan::Platform

#[repr(transparent)]
pub struct Platform(_);

A type containing information on the target platform which may optionally be provided to the compile calls

Implementations

impl Platform

pub fn is_valid() -> Result<()>

Utility function to test the current system architecture.

Hyperscan requires the Supplemental Streaming SIMD Extensions 3 instruction set. This function can be called on any x86 platform to determine if the system provides the required instruction set.

This function does not test for more advanced features if Hyperscan has been built for a more specific architecture, for example the AVX2 instruction set.

pub fn host() -> Result<Platform>

Populates the platform information based on the current host.

pub fn new(tune: Tune, cpu_features: CpuFeatures) -> Platform

Constructs a target platform which may be used to guide the optimisation process of the compile.

Trait Implementations

impl AsMut<PlatformRef> for Platform

fn as_mut(&mut self) -> &mut PlatformRef

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<PlatformRef> for Platform

fn as_ref(&self) -> &PlatformRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<PlatformRef> for Platform

fn borrow(&self) -> &PlatformRef

Immutably borrows from an owned value.

impl BorrowMut<PlatformRef> for Platform

fn borrow_mut(&mut self) -> &mut PlatformRef

Mutably borrows from an owned value.

impl Deref for Platform

type Target = PlatformRef

The resulting type after dereferencing.

fn deref(&self) -> &PlatformRef

Dereferences the value.

impl DerefMut for Platform

fn deref_mut(&mut self) -> &mut PlatformRef

Mutably dereferences the value.

impl Drop for Platform

fn drop(&mut self)

Executes the destructor for this type.

impl ForeignType for Platform

type CType = hs_platform_info

The raw C type.

type Ref = PlatformRef

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut hs_platform_info_t) -> Platform

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut hs_platform_info_t

Returns a raw pointer to the wrapped value.

fn into_ptr(self) -> *mut Self::CType

Consumes the wrapper and returns the raw pointer.

impl Send for Platform

impl Sync for Platform