Struct clang_sys::CXDiagnostic

pub struct CXDiagnostic(pub *mut c_void);

Methods from Deref<Target=*mut c_void>

fn is_null(self) -> bool

Returns true if the pointer is null.

Examples

Basic usage:

let s: &str = "Follow the rabbit";
let ptr: *const u8 = s.as_ptr();
assert!(!ptr.is_null());

unsafe fn as_ref(self) -> Option<&'a T>

Returns None if the pointer is null, or else returns a reference to the value wrapped in Some.

Safety

While this method and its mutable counterpart are useful for null-safety, it is important to note that this is still an unsafe operation because the returned value could be pointing to invalid memory.

Additionally, the lifetime 'a returned is arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.

Examples

Basic usage:

let val: *const u8 = &10u8 as *const u8;

unsafe {
    if let Some(val_back) = val.as_ref() {
        println!("We got back the value: {}!", val_back);
    }
}

unsafe fn offset(self, count: isize) -> *const T

Calculates the offset from a pointer. count is in units of T; e.g. a count of 3 represents a pointer offset of 3 * sizeof::<T>() bytes.

Safety

Both the starting and resulting pointer must be either in bounds or one byte past the end of an allocated object. If either pointer is out of bounds or arithmetic overflow occurs then any further use of the returned value will result in undefined behavior.

Examples

Basic usage:

let s: &str = "123";
let ptr: *const u8 = s.as_ptr();

unsafe {
    println!("{}", *ptr.offset(1) as char);
    println!("{}", *ptr.offset(2) as char);
}

Trait Implementations

impl Copy for CXDiagnostic

impl Clone for CXDiagnostic

fn clone(&self) -> CXDiagnostic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CXDiagnostic

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for CXDiagnostic

fn default() -> CXDiagnostic

Returns the "default value" for a type.

impl Deref for CXDiagnostic

type Target = *mut c_void

The resulting type after dereferencing

fn deref(&self) -> &Self::Target

The method called to dereference a value