#[repr(C)]pub struct WebHistoryItem { /* private fields */ }
WebHistoryItem
only.Expand description
WebHistoryItems are created by WebKit to represent pages visited. The WebBackForwardList and WebHistory classes both use WebHistoryItems to represent pages visited. With the exception of the displayTitle, the properties of WebHistoryItems are set by WebKit. WebHistoryItems are normally never created directly.
See also Appleโs documentation
Implementationsยง
Sourceยงimpl WebHistoryItem
impl WebHistoryItem
Sourcepub unsafe fn initWithURLString_title_lastVisitedTimeInterval(
this: Allocated<Self>,
url_string: Option<&NSString>,
title: Option<&NSString>,
time: NSTimeInterval,
) -> Option<Retained<Self>>
๐Deprecated
pub unsafe fn initWithURLString_title_lastVisitedTimeInterval( this: Allocated<Self>, url_string: Option<&NSString>, title: Option<&NSString>, time: NSTimeInterval, ) -> Option<Retained<Self>>
Parameter URLString
: The URL string for the item.
Parameter title
: The title to use for the item. This is normally the
Parameter time
: The time used to indicate when the item was used.
Initialize a new WebHistoryItem
WebHistoryItems are normally created for you by the WebKit. You may use this method to prepopulate a WebBackForwardList, or create โartificialโ items to add to a WebBackForwardList. When first initialized the URLString and originalURLString will be the same.
Sourcepub unsafe fn originalURLString(&self) -> Retained<NSString>
๐Deprecated
pub unsafe fn originalURLString(&self) -> Retained<NSString>
The string representation of the initial URL of this item. This value is normally set by the WebKit.
Sourcepub unsafe fn URLString(&self) -> Retained<NSString>
๐Deprecated
pub unsafe fn URLString(&self) -> Retained<NSString>
The string representation of the URL represented by this item.
The URLString may be different than the originalURLString if the page redirected to a new location. This value is normally set by the WebKit.
Sourcepub unsafe fn title(&self) -> Retained<NSString>
๐Deprecated
pub unsafe fn title(&self) -> Retained<NSString>
The title of the page represented by this item.
This title cannot be changed by the client. This value is normally set by the WebKit when a page title for the item is received.
Sourcepub unsafe fn lastVisitedTimeInterval(&self) -> NSTimeInterval
๐Deprecated
pub unsafe fn lastVisitedTimeInterval(&self) -> NSTimeInterval
The last time the page represented by this item was visited. The interval is since the reference date as determined by NSDate. This value is normally set by the WebKit.
pub unsafe fn alternateTitle(&self) -> Retained<NSString>
Sourcepub unsafe fn setAlternateTitle(&self, alternate_title: Option<&NSString>)
๐Deprecated
pub unsafe fn setAlternateTitle(&self, alternate_title: Option<&NSString>)
Setter for alternateTitle
.
Methods from Deref<Target = NSObject>ยง
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesnโt recognize.
See Appleโs documentation for details.
Methods from Deref<Target = AnyObject>ยง
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
Dynamically find the class of this object.
ยง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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
๐Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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ยง
Sourceยงimpl AsRef<AnyObject> for WebHistoryItem
impl AsRef<AnyObject> for WebHistoryItem
Sourceยงimpl AsRef<NSObject> for WebHistoryItem
impl AsRef<NSObject> for WebHistoryItem
Sourceยงimpl AsRef<WebHistoryItem> for WebHistoryItem
impl AsRef<WebHistoryItem> for WebHistoryItem
Sourceยงimpl Borrow<AnyObject> for WebHistoryItem
impl Borrow<AnyObject> for WebHistoryItem
Sourceยงimpl Borrow<NSObject> for WebHistoryItem
impl Borrow<NSObject> for WebHistoryItem
Sourceยงimpl ClassType for WebHistoryItem
impl ClassType for WebHistoryItem
Sourceยงconst NAME: &'static str = "WebHistoryItem"
const NAME: &'static str = "WebHistoryItem"
Sourceยงtype ThreadKind = <<WebHistoryItem as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<WebHistoryItem as ClassType>::Super as ClassType>::ThreadKind
Sourceยงimpl CopyingHelper for WebHistoryItem
impl CopyingHelper for WebHistoryItem
Sourceยงtype Result = WebHistoryItem
type Result = WebHistoryItem
Self
if the type has no
immutable counterpart. Read moreSourceยงimpl Debug for WebHistoryItem
impl Debug for WebHistoryItem
Sourceยงimpl Deref for WebHistoryItem
impl Deref for WebHistoryItem
Sourceยงimpl Hash for WebHistoryItem
impl Hash for WebHistoryItem
Sourceยงimpl Message for WebHistoryItem
impl Message for WebHistoryItem
Sourceยงimpl NSCopying for WebHistoryItem
impl NSCopying for WebHistoryItem
Sourceยงimpl NSObjectProtocol for WebHistoryItem
impl NSObjectProtocol for WebHistoryItem
Sourceยงfn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Sourceยงfn hash(&self) -> usize
fn hash(&self) -> usize
Sourceยงfn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Sourceยงfn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref