Struct glib::char::Char

source ·
pub struct Char(pub c_char);
Expand description

Wrapper for values where C functions expect a plain C char

Consider the following C function prototype from glib:

void g_key_file_set_list_separator (GKeyFile *key_file, gchar separator);

This function plainly expects a byte as the separator argument. However, having this function exposed to Rust as the following would be inconvenient:

impl KeyFile {
    pub fn set_list_separator(&self, separator: libc:c_char) { }
}

This would be inconvenient because users would have to do the conversion from a Rust char to an libc::c_char by hand, which is just a type alias for i8 on most system.

This Char type is a wrapper over an libc::c_char, so that we can pass it to Glib or C functions. The check for whether a Rust char (a Unicode scalar value) actually fits in a libc::c_char is done in the new function; see its documentation for details.

The inner libc::c_char (which is equivalent to i8) can be extracted with .0, or by calling my_char.into_glib().

Examples

use glib::Char;
use std::convert::TryFrom;

Char::from(b'a');
Char::try_from('a').unwrap();
assert!(Char::try_from('☔').is_err());
extern "C" fn have_a_byte(b: libc::c_char);

have_a_byte(Char::from(b'a').into_glib());

Tuple Fields§

§0: c_char

Trait Implementations§

source§

impl Clone for Char

source§

fn clone(&self) -> Char

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Char

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Char> for char

source§

fn from(c: Char) -> char

Converts to this type from the input type.
source§

impl From<Char> for u8

source§

fn from(c: Char) -> u8

Converts to this type from the input type.
source§

impl From<u8> for Char

source§

fn from(c: u8) -> Char

Converts to this type from the input type.
source§

impl PartialEq<Char> for Char

source§

fn eq(&self, other: &Char) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl TryFrom<char> for Char

§

type Error = TryFromIntError

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

fn try_from(c: char) -> Result<Char, Self::Error>

Performs the conversion.
source§

impl Copy for Char

source§

impl Eq for Char

source§

impl StructuralEq for Char

source§

impl StructuralPartialEq for Char

Auto Trait Implementations§

§

impl RefUnwindSafe for Char

§

impl Send for Char

§

impl Sync for Char

§

impl Unpin for Char

§

impl UnwindSafe for Char

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · 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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.