pyo3_ffi

# Struct PyASCIIObject

Source

    #[repr(C)]pub struct PyASCIIObject {
        pub ob_base: PyObject,
        pub length: Py_ssize_t,
        pub hash: Py_hash_t,
        pub state: u32,
    }

## Fields§

§ `ob_base: PyObject` § `length: Py_ssize_t` § `hash: Py_hash_t` § `state: u32`

A bit field with various properties.

Rust doesn’t expose bitfields. So we have accessor functions for retrieving values.

unsigned int interned:2; // SSTATE_* constants. unsigned int kind:3; // PyUnicode_*_KIND constants. unsigned int compact:1; unsigned int ascii:1; unsigned int ready:1; unsigned int :24;

## Implementations§

Source §

### impl PyASCIIObject

Interacting with the bitfield is not actually well-defined, so we mark these APIs unsafe.

Source

#### pub unsafe fn interned(&self) -> c_uint

Get the `interned` field of the `PyASCIIObject` state bitfield.

Returns one of: `SSTATE_NOT_INTERNED`, `SSTATE_INTERNED_MORTAL`, `SSTATE_INTERNED_IMMORTAL`, or `SSTATE_INTERNED_IMMORTAL_STATIC`.

Source

#### pub unsafe fn set_interned(&mut self, val: c_uint)

Set the `interned` field of the `PyASCIIObject` state bitfield.

Calling this function with an argument that is not `SSTATE_NOT_INTERNED`, `SSTATE_INTERNED_MORTAL`, `SSTATE_INTERNED_IMMORTAL`, or `SSTATE_INTERNED_IMMORTAL_STATIC` is invalid.

Source

#### pub unsafe fn kind(&self) -> c_uint

Get the `kind` field of the `PyASCIIObject` state bitfield.

Returns one of: `PyUnicode_1BYTE_KIND`, `PyUnicode_2BYTE_KIND`, or `PyUnicode_4BYTE_KIND`.

Source

#### pub unsafe fn set_kind(&mut self, val: c_uint)

Set the `kind` field of the `PyASCIIObject` state bitfield.

Calling this function with an argument that is not `PyUnicode_1BYTE_KIND`, `PyUnicode_2BYTE_KIND`, or `PyUnicode_4BYTE_KIND` is invalid.

Source

#### pub unsafe fn compact(&self) -> c_uint

Get the `compact` field of the `PyASCIIObject` state bitfield.

Returns either `0` or `1`.

Source

#### pub unsafe fn set_compact(&mut self, val: c_uint)

Set the `compact` flag of the `PyASCIIObject` state bitfield.

Calling this function with an argument that is neither `0` nor `1` is invalid.

Source

#### pub unsafe fn ascii(&self) -> c_uint

Get the `ascii` field of the `PyASCIIObject` state bitfield.

Returns either `0` or `1`.

Source

#### pub unsafe fn set_ascii(&mut self, val: c_uint)

Set the `ascii` flag of the `PyASCIIObject` state bitfield.

Calling this function with an argument that is neither `0` nor `1` is invalid.

## Auto Trait Implementations§

§

### impl Freeze for PyASCIIObject

§

### impl RefUnwindSafe for PyASCIIObject

§

### impl !Send for PyASCIIObject

§

### impl !Sync for PyASCIIObject

§

### impl Unpin for PyASCIIObject

§

### impl UnwindSafe for PyASCIIObject

## Blanket Implementations§

Source §

### impl<T> Any for T
where T: 'static + ?Sized,

Source §

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source §

### impl<T> Borrow<T> for T
where T: ?Sized,

Source §

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source §

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source §

### impl<T> From<T> for T

Source §

#### fn from(t: T) -> T

Returns the argument unchanged.

Source §

### impl<T, U> Into<U> for T
where U: From<T>,

Source §

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source §

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source §

#### type Error = Infallible

The type returned in the event of a conversion error.
Source §

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source §

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source §

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source §

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.