Struct AVMutableCaptionRegion 

pub struct AVMutableCaptionRegion { /* private fields */ }

Available on crate feature AVCaption only.

Mutable subclass of AVCaptionRegion.

See also Apple’s documentation

Implementations

impl AVMutableCaptionRegion

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Create a region object without any properties.

pub unsafe fn initWithIdentifier( this: Allocated<Self>, identifier: &NSString, ) -> Retained<Self>

Create a region object with the identifier.

pub unsafe fn origin(&self) -> AVCaptionPoint

Available on crate feature objc2-core-foundation only.

The position of the top-left of the region.

pub unsafe fn setOrigin(&self, origin: AVCaptionPoint)

Available on crate feature objc2-core-foundation only.

Setter for origin.

pub unsafe fn size(&self) -> AVCaptionSize

Available on crate feature objc2-core-foundation only.

The width and height of the region, potentally with unspecified fields.

pub unsafe fn setSize(&self, size: AVCaptionSize)

Available on crate feature objc2-core-foundation only.

Setter for size.

pub unsafe fn scroll(&self) -> AVCaptionRegionScroll

Region scroll mode.

pub unsafe fn setScroll(&self, scroll: AVCaptionRegionScroll)

Setter for scroll.

pub unsafe fn displayAlignment(&self) -> AVCaptionRegionDisplayAlignment

Alignment of lines in the region.

pub unsafe fn setDisplayAlignment( &self, display_alignment: AVCaptionRegionDisplayAlignment, )

Setter for displayAlignment.

pub unsafe fn writingMode(&self) -> AVCaptionRegionWritingMode

The block and inline progression direction of the region.

pub unsafe fn setWritingMode(&self, writing_mode: AVCaptionRegionWritingMode)

Setter for writingMode.

impl AVMutableCaptionRegion

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = AVCaptionRegion>

pub unsafe fn identifier(&self) -> Option<Retained<NSString>>

Identifier for the region

When regionIdentifier is nil, two regions with the same position and endPosition are considered to be same, that is captions referring these regions belong to the same region when serialized to a format like TTML. In addition, the AVCaptionRegion cannot be mutably copied.

When regionIdentifier is not nil, two regions are same if and only if the region identifier is equal. It is a client’s responsibility to ensure these AVCaptionRegion objects have the same properties.

pub unsafe fn origin(&self) -> AVCaptionPoint

Available on crate feature objc2-core-foundation only.

The position of the top-left of the region, potentially with unspecified fields.

It returns an AVCaptionPoint potentially with unspecified x and/or y fields. Unspecified dimensions indicate the region doesn’t have positioning information for that dimension.

pub unsafe fn size(&self) -> AVCaptionSize

Available on crate feature objc2-core-foundation only.

The width and height of the region, potentally with unspecified fields.

It returns an AVCaptionSize potentially with unspecified width and/or height. CEA608 closed captions support limits the size.height property’s value to 1 cell except when the AVCaptionRegionScroll is AVCaptionRegionScrollRollUp. If the AVCaptionRegionScroll is AVCaptionRegionScrollRollUp, the size.height property’s value must be 2, 3 or 4 cells. It returns an AVCaptionSize with unspecifed width and height when the region doesn’t have width or height information.

pub unsafe fn scroll(&self) -> AVCaptionRegionScroll

Scroll mode for the region

See AVCaptionRegionScrollXXX enum for possible values.

pub unsafe fn displayAlignment(&self) -> AVCaptionRegionDisplayAlignment

Alignment of lines for the region

pub unsafe fn writingMode(&self) -> AVCaptionRegionWritingMode

The block and inline progression direction of the region.

pub unsafe fn encodeWithCoder(&self, encoder: &NSCoder)

NSCoding protocol method override

This method throws an exception if the caption region’s size has different units for width and height, or if the units are unrecognizeable.

Safety

encoder possibly has further requirements.

pub unsafe fn isEqual(&self, object: &AnyObject) -> bool

NSObject protocol method override

This method throws an exception if the caption region’s size has different units for width and height, or if the units are unrecognizeable.

Safety

object should be of the correct type.

pub unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone, ) -> Retained<AnyObject>

NSMutableCopying protocol method override

This method throws an exception if the caption region contains an identifier.

Safety

zone must be a valid pointer or null.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AVCaptionRegion> for AVMutableCaptionRegion

fn as_ref(&self) -> &AVCaptionRegion

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

impl AsRef<AVMutableCaptionRegion> for AVMutableCaptionRegion

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVMutableCaptionRegion

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVMutableCaptionRegion

fn as_ref(&self) -> &NSObject

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

impl Borrow<AVCaptionRegion> for AVMutableCaptionRegion

fn borrow(&self) -> &AVCaptionRegion

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AVMutableCaptionRegion

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVMutableCaptionRegion

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVMutableCaptionRegion

const NAME: &'static str = "AVMutableCaptionRegion"

The name of the Objective-C class that this type represents.

type Super = AVCaptionRegion

The superclass of this class.

type ThreadKind = <<AVMutableCaptionRegion as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for AVMutableCaptionRegion

type Result = AVCaptionRegion

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for AVMutableCaptionRegion

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

Formats the value using the given formatter.

impl Deref for AVMutableCaptionRegion

type Target = AVCaptionRegion

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVMutableCaptionRegion

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 AVMutableCaptionRegion

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

where Self: Sized,

Increment the reference count of the receiver.

impl MutableCopyingHelper for AVMutableCaptionRegion

type Result = AVMutableCaptionRegion

The mutable counterpart of the type, or Self if the type has no mutable counterpart.

impl NSCoding for AVMutableCaptionRegion

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSCopying for AVMutableCaptionRegion

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSMutableCopying for AVMutableCaptionRegion

fn mutableCopy(&self) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone, ) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

impl NSObjectProtocol for AVMutableCaptionRegion

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for AVMutableCaptionRegion

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for AVMutableCaptionRegion

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 AVMutableCaptionRegion

const ENCODING_REF: Encoding = <AVCaptionRegion as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for AVMutableCaptionRegion

impl Eq for AVMutableCaptionRegion