Struct places::msg_types::BookmarkNode

pub struct BookmarkNode {
    pub node_type: Option<i32>,
    pub guid: Option<String>,
    pub date_added: Option<i64>,
    pub last_modified: Option<i64>,
    pub parent_guid: Option<String>,
    pub position: Option<u32>,
    pub title: Option<String>,
    pub url: Option<String>,
    pub child_guids: Vec<String>,
    pub child_nodes: Vec<BookmarkNode>,
    pub have_child_nodes: Option<bool>,
}

A bookmark node.

We use a single message type for bookmarks. It covers insertion, deletion, and update, and represents all three bookmark types.

This simplifies the FFI by reducing the number of types that must go across it, and retuces boilderplate, but removes some static-ish guarantees we might have otherwise.

Note that these docs comments are internal, and don't necessarily impact the actual API we expose to Kotlin/Swift (this is particularly true around reads).

Fields

node_type: Option<i32>

The type of this bookmark, a BookmarkType (from types.rs).

This impacts which fields may be present.

It's illegal to attempt to change this when updating a bookmark.

Note: this probably should be an enum, but prost seems to get upset about it so we're just using int32 for now.

Note: this is node_type and not type because type is reserved in Rust.

• Always returned on reads.
• Required for inserts.
• Not provided for updates.

guid: Option<String>

The bookmarks guid.

• Always returned on reads.
• Not allowed for inserts.
• Required for updates (specifies which record is being changed)

date_added: Option<i64>

Creation time, in milliseconds since the unix epoch.

May not be a local timestamp, and may shift if new devices are able to provide an earlier (but still valid) timestamp.

• Always returned on reads.
• Ignored for insertion and update.

last_modified: Option<i64>

Last modification time, in milliseconds since the unix epoch.

• Always returned on reads.
• Ignored for insertion and update.

parent_guid: Option<String>

Guid of the parent record.

• Returned on reads, except for reads of the bookmark root.
• Required for insertion.
• On updates, if provided, we treat it as a move.
  • Interacts with position, see its documentation below for details on how.

position: Option<u32>

Zero based index within the parent.

• Not provided on reads (for now).

• Allowed for insertion.

  • Leaving it out means 'end of folder'.

• Allowed for updates.

  • If parent_guid is not provided and position is, we treat this a move within the same folder.

  • If parent_guid and position are both provided, we treat this as a move to / within that folder, and we insert at the requested position.

  • If position is not provided (and parent_guid is) then it's treated as a move to the end of that folder.

title: Option<String>

Bookmark title. Not present for type = BookmarkType::Separator.

• Returned on reads if it exists.
• Required when inserting folders.

url: Option<String>

Bookmark URL. Only allowed/present for type = BookmarkType::Bookmark.

• Always returned on reads (for BookmarkType::Bookmark).
• Required when inserting a new bookmark.

child_guids: Vec<String>

IDs of folder children, in order. Only present for type = BookmarkType::Folder.

• Returned on reads (for BookmarkType::Folder).
• Forbidden for insertions and updates.
• Not provided if child_nodes is provided, to avoid sending more data over the FFI than necessary.

child_nodes: Vec<BookmarkNode>

Data about folder children, in order. Only present for type = BookmarkType::Folder.

For performance reasons, this only is provided if it's requested.

have_child_nodes: Option<bool>

Returned by reads, and used to distinguish between the cases of "empty child_nodes because the API doesn't return children" and "empty child_nodes because this folder has no children (but we'd populate them if it had them)".

Only required because you can't have optional repeated.

Leaving this out is equivalent to false.

Implementations

impl BookmarkNode

pub(crate) fn get_node_type(&self) -> BookmarkType

Get the BookmarkType, panicking if it's invalid (because it really never should be unless we have a bug somewhere).

pub fn into_insertable(self) -> Result<InsertableItem>

Convert the protobuf bookmark into information for insertion.

impl BookmarkNode

pub fn node_type(&self) -> i32

Returns the value of node_type, or the default value if node_type is unset.

pub fn guid(&self) -> &str

Returns the value of guid, or the default value if guid is unset.

pub fn date_added(&self) -> i64

Returns the value of date_added, or the default value if date_added is unset.

pub fn last_modified(&self) -> i64

Returns the value of last_modified, or the default value if last_modified is unset.

pub fn parent_guid(&self) -> &str

Returns the value of parent_guid, or the default value if parent_guid is unset.

pub fn position(&self) -> u32

Returns the value of position, or the default value if position is unset.

pub fn title(&self) -> &str

Returns the value of title, or the default value if title is unset.

pub fn url(&self) -> &str

Returns the value of url, or the default value if url is unset.

pub fn have_child_nodes(&self) -> bool

Returns the value of have_child_nodes, or the default value if have_child_nodes is unset.

Trait Implementations

impl Clone for BookmarkNode

fn clone(&self) -> BookmarkNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BookmarkNode

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

Formats the value using the given formatter.

impl Default for BookmarkNode

fn default() -> BookmarkNode

Returns the "default value" for a type.

impl From<BookmarkNode> for BookmarkUpdateInfo

fn from(n: BookmarkNode) -> Self

Performs the conversion.

impl From<PublicNode> for BookmarkNode

fn from(n: PublicNode) -> Self

Performs the conversion.

impl IntoFfi for BookmarkNode where
    BookmarkNode: Message, 

type Value = ByteBuffer

This type must be:

fn ffi_default() -> Self::Value

Return an 'empty' value. This is what's passed back to C in the case of an error, so it doesn't actually need to be "empty", so much as "ignorable". Note that this is also used when an empty Option<T> is returned.

fn into_ffi_value(self) -> Self::Value

Convert ourselves into a value we can pass back to C with confidence.

impl Message for BookmarkNode

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<BookmarkNode> for BookmarkNode

fn eq(&self, other: &BookmarkNode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BookmarkNode) -> bool

This method tests for !=.

impl StructuralPartialEq for BookmarkNode