Struct places::observation::VisitObservation

[+] Show declaration

pub struct VisitObservation {
    pub url: String,
    pub title: Option<String>,
    pub visit_type: Option<VisitTransition>,
    pub is_error: Option<bool>,
    pub is_redirect_source: Option<bool>,
    pub is_permanent_redirect_source: Option<bool>,
    pub at: Option<Timestamp>,
    pub referrer: Option<String>,
    pub is_remote: Option<bool>,
}

[−] Expand description

An "observation" based model for updating history. You create a VisitObservation, call functions on it which correspond with what you observed. The page will then be updated using this info.

It's implemented such that the making of an "observation" is itself significant - it records what specific changes should be made to storage. For example, instead of simple bools with defaults (where you can't differentiate explicitly setting a value from the default value), we use Option, with the idea being it's better for a store shaped like Mentat.

It exposes a "builder api", but for convenience, that API allows Options too. So, eg, .with_title(None) or with_is_error(None) is allowed but records no observation.

Fields

url: String

[−] Expand description

Ideally, we'd use url::Url here with serde_url, but we really would like to expose these errors over the FFI as UrlParseErrors and not json errors, and we also would like to do so without parsing strings.

title: Option<String>

visit_type: Option<VisitTransition>

is_error: Option<bool>

is_redirect_source: Option<bool>

is_permanent_redirect_source: Option<bool>

at: Option<Timestamp>

referrer: Option<String>

[−] Expand description

Semantically also a url::Url, See the comment about the url property.

is_remote: Option<bool>

Implementations

impl VisitObservation[−]

pub fn new(url: Url) -> Self

pub fn with_title(self, t: impl Into<Option<String>>) -> Self

pub fn with_visit_type(self, t: impl Into<Option<VisitTransition>>) -> Self

pub fn with_is_error(self, v: impl Into<Option<bool>>) -> Self

pub fn with_is_redirect_source(self, v: impl Into<Option<bool>>) -> Self

pub fn with_is_permanent_redirect_source(
    self,
    v: impl Into<Option<bool>>
) -> Self

pub fn with_at(self, v: impl Into<Option<Timestamp>>) -> Self

pub fn with_is_remote(self, v: impl Into<Option<bool>>) -> Self

pub fn with_referrer(self, v: impl Into<Option<Url>>) -> Self

pub fn get_redirect_frecency_boost(&self) -> bool

pub fn get_is_hidden(&self) -> bool

Trait Implementations

impl Debug for VisitObservation[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VisitObservation[+]

[+] Show hidden undocumented items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Serialize for VisitObservation[+]

[+] Show hidden undocumented items

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, [−]

Serialize this value into the given Serde serializer.