Struct CFWriteStream 

pub struct CFWriteStream { /* private fields */ }

Available on crate feature CFStream only.

Apple’s documentation

This is toll-free bridged with NSOutputStream.

Implementations

impl CFWriteStream

pub unsafe fn with_buffer( alloc: Option<&CFAllocator>, buffer: *mut u8, buffer_capacity: CFIndex, ) -> Option<CFRetained<CFWriteStream>>

Safety

• alloc might not allow None.
• buffer must be a valid pointer.

pub fn with_allocated_buffers( alloc: Option<&CFAllocator>, buffer_allocator: Option<&CFAllocator>, ) -> Option<CFRetained<CFWriteStream>>

impl CFWriteStream

pub fn with_file( alloc: Option<&CFAllocator>, file_url: Option<&CFURL>, ) -> Option<CFRetained<CFWriteStream>>

Available on crate feature CFURL only.

impl CFWriteStream

pub fn status(&self) -> CFStreamStatus

impl CFWriteStream

pub fn copy_error(&self) -> Option<CFRetained<CFError>>

Available on crate feature CFError only.

impl CFWriteStream

pub fn open(&self) -> bool

impl CFWriteStream

pub fn close(&self)

impl CFWriteStream

pub fn can_accept_bytes(&self) -> bool

pub unsafe fn write(&self, buffer: *const u8, buffer_length: CFIndex) -> CFIndex

Safety

buffer must be a valid pointer.

impl CFWriteStream

pub fn property( &self, property_name: Option<&CFStreamPropertyKey>, ) -> Option<CFRetained<CFType>>

impl CFWriteStream

pub unsafe fn set_property( &self, property_name: Option<&CFStreamPropertyKey>, property_value: Option<&CFType>, ) -> bool

Safety

• property_name might not allow None.
• property_value should be of the correct type.
• property_value might not allow None.

impl CFWriteStream

pub unsafe fn set_client( &self, stream_events: CFOptionFlags, client_cb: CFWriteStreamClientCallBack, client_context: *mut CFStreamClientContext, ) -> bool

Safety

• client_cb must be implemented correctly.
• client_context must be a valid pointer.

impl CFWriteStream

pub fn schedule_with_run_loop( &self, run_loop: Option<&CFRunLoop>, run_loop_mode: Option<&CFRunLoopMode>, )

Available on crate feature CFRunLoop only.

impl CFWriteStream

pub fn unschedule_from_run_loop( &self, run_loop: Option<&CFRunLoop>, run_loop_mode: Option<&CFRunLoopMode>, )

Available on crate feature CFRunLoop only.

impl CFWriteStream

pub unsafe fn set_dispatch_queue(&self, q: Option<&DispatchQueue>)

Available on crate feature dispatch2 only.

Safety

• q possibly has additional threading requirements.
• q might not allow None.

impl CFWriteStream

pub fn dispatch_queue(&self) -> Option<DispatchRetained<DispatchQueue>>

Available on crate feature dispatch2 only.

impl CFWriteStream

pub fn error(&self) -> CFStreamError

Methods from Deref<Target = CFType>

pub fn downcast_ref<T: ConcreteType>(&self) -> Option<&T>

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for CFWriteStream

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for CFWriteStream

fn as_ref(&self) -> &CFType

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

impl AsRef<CFWriteStream> for CFWriteStream

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for CFWriteStream

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CFWriteStream

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CFWriteStream

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for CFWriteStream

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

Formats the value using the given formatter.

impl Deref for CFWriteStream

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CFWriteStream

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 Message for CFWriteStream

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CFWriteStream

fn eq(&self, other: &Self) -> 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 RefEncode for CFWriteStream

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for CFWriteStream

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for CFWriteStream