Struct LayoutDom

#[repr(transparent)]
pub(crate) struct LayoutDom<'dom, T> {
    value: &'dom T,
}

An unrooted reference to a DOM object for use in layout. Layout*Helpers traits must be implemented on this.

Fields

value: &'dom T

Implementations

impl<'dom, T> LayoutDom<'dom, T>

where T: Castable,

pub(crate) fn upcast<U>(&self) -> LayoutDom<'dom, U>

where U: Castable, T: DerivedFrom<U>,

Cast a DOM object root upwards to one of the interfaces it derives from.

pub(crate) fn downcast<U>(&self) -> Option<LayoutDom<'dom, U>>

where U: DerivedFrom<T>,

Cast a DOM object downwards to one of the interfaces it might implement.

pub(crate) fn is<U>(&self) -> bool

where U: DerivedFrom<T>,

Returns whether this inner object is a U.

impl<T> LayoutDom<'_, T>

where T: DomObject,

pub(crate) unsafe fn get_jsobject(&self) -> *mut JSObject

Get the reflector.

impl LayoutDom<'_, Node>

pub(crate) unsafe fn from_trusted_node_address( inner: TrustedNodeAddress, ) -> Self

Create a new JS-owned value wrapped from an address known to be a Node pointer.

impl<'dom, T> LayoutDom<'dom, T>

where T: 'dom + DomObject,

pub(crate) fn unsafe_get(self) -> &'dom T

Returns a reference to the interior of this JS object. The fact that this is unsafe is what necessitates the layout wrappers.

pub(crate) unsafe fn to_layout_slice( slice: &'dom [Dom<T>], ) -> &'dom [LayoutDom<'dom, T>]

Transforms a slice of Dom<T> into a slice of LayoutDom<T>.

impl LayoutDom<'_, Element>

pub(super) fn focus_state(self) -> bool

impl<'dom> LayoutDom<'dom, HTMLImageElement>

fn current_request(self) -> &'dom ImageRequest

fn dimension_attribute_source(self) -> LayoutDom<'dom, Element>

impl<'dom> LayoutDom<'dom, HTMLInputElement>

fn get_raw_textinput_value(self) -> DOMString

fn get_filelist(self) -> Option<LayoutDom<'dom, FileList>>

fn input_type(self) -> InputType

fn textinput_sorted_selection_offsets_range(self) -> Range<UTF8Bytes>

impl<'dom> LayoutDom<'dom, HTMLTextAreaElement>

fn textinput_content(self) -> DOMString

fn textinput_sorted_selection_offsets_range(self) -> Range<UTF8Bytes>

fn placeholder(self) -> &'dom str

impl LayoutDom<'_, HTMLVideoElement>

fn width_attr(self) -> Option<LengthOrPercentageOrAuto>

fn height_attr(self) -> Option<LengthOrPercentageOrAuto>

impl<'dom> LayoutDom<'dom, Node>

pub(crate) fn parent_node_ref(self) -> Option<LayoutDom<'dom, Node>>

Trait Implementations

impl<'dom> AttrHelpersForLayout<'dom> for LayoutDom<'dom, Attr>

fn value(self) -> &'dom AttrValue

fn as_str(&self) -> &'dom str

fn to_tokens(self) -> Option<&'dom [Atom]>

fn local_name(self) -> &'dom LocalName

fn namespace(self) -> &'dom Namespace

impl<T> Clone for LayoutDom<'_, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl HTMLBodyElementLayoutHelpers for LayoutDom<'_, HTMLBodyElement>

fn get_background_color(self) -> Option<AbsoluteColor>

fn get_color(self) -> Option<AbsoluteColor>

fn get_background(self) -> Option<ServoUrl>

impl HTMLFontElementLayoutHelpers for LayoutDom<'_, HTMLFontElement>

fn get_color(self) -> Option<AbsoluteColor>

fn get_face(self) -> Option<Atom>

fn get_size(self) -> Option<u32>

impl HTMLHRLayoutHelpers for LayoutDom<'_, HTMLHRElement>

fn get_color(self) -> Option<AbsoluteColor>

fn get_width(self) -> LengthOrPercentageOrAuto

fn get_size_info(self) -> Option<SizePresentationalHint>

impl HTMLIFrameElementLayoutMethods for LayoutDom<'_, HTMLIFrameElement>

fn pipeline_id(self) -> Option<PipelineId>

fn browsing_context_id(self) -> Option<BrowsingContextId>

fn get_width(self) -> LengthOrPercentageOrAuto

fn get_height(self) -> LengthOrPercentageOrAuto

impl<'dom> HTMLTableCellElementLayoutHelpers<'dom> for LayoutDom<'dom, HTMLTableCellElement>

fn get_background_color(self) -> Option<AbsoluteColor>

fn get_colspan(self) -> Option<u32>

fn get_rowspan(self) -> Option<u32>

fn get_table(self) -> Option<LayoutDom<'dom, HTMLTableElement>>

fn get_width(self) -> LengthOrPercentageOrAuto

fn get_height(self) -> LengthOrPercentageOrAuto

impl<'dom> HTMLTableColElementLayoutHelpers<'dom> for LayoutDom<'dom, HTMLTableColElement>

fn get_span(self) -> Option<u32>

fn get_width(self) -> LengthOrPercentageOrAuto

impl HTMLTableElementLayoutHelpers for LayoutDom<'_, HTMLTableElement>

fn get_background_color(self) -> Option<AbsoluteColor>

fn get_border(self) -> Option<u32>

fn get_cellpadding(self) -> Option<u32>

fn get_cellspacing(self) -> Option<u32>

fn get_width(self) -> LengthOrPercentageOrAuto

fn get_height(self) -> LengthOrPercentageOrAuto

impl HTMLTableRowElementLayoutHelpers for LayoutDom<'_, HTMLTableRowElement>

fn get_background_color(self) -> Option<AbsoluteColor>

fn get_height(self) -> LengthOrPercentageOrAuto

impl HTMLTableSectionElementLayoutHelpers for LayoutDom<'_, HTMLTableSectionElement>

fn get_background_color(self) -> Option<AbsoluteColor>

fn get_height(self) -> LengthOrPercentageOrAuto

impl<T> Hash for LayoutDom<'_, T>

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 LayoutCanvasRenderingContextHelpers for LayoutDom<'_, CanvasRenderingContext2D>

fn canvas_data_source(self) -> Option<ImageKey>

None is rendered as transparent black (cleared canvas)

impl LayoutCanvasRenderingContextHelpers for LayoutDom<'_, GPUCanvasContext>

fn canvas_data_source(self) -> Option<ImageKey>

None is rendered as transparent black (cleared canvas)

impl LayoutCanvasRenderingContextHelpers for LayoutDom<'_, ImageBitmapRenderingContext>

fn canvas_data_source(self) -> Option<ImageKey>

None is rendered as transparent black (cleared canvas)

impl LayoutCanvasRenderingContextHelpers for LayoutDom<'_, WebGL2RenderingContext>

fn canvas_data_source(self) -> Option<ImageKey>

None is rendered as transparent black (cleared canvas)

impl LayoutCanvasRenderingContextHelpers for LayoutDom<'_, WebGLRenderingContext>

fn canvas_data_source(self) -> Option<ImageKey>

None is rendered as transparent black (cleared canvas)

impl<'dom> LayoutCharacterDataHelpers<'dom> for LayoutDom<'dom, CharacterData>

fn data_for_layout(self) -> &'dom str

impl<'dom> LayoutDocumentHelpers<'dom> for LayoutDom<'dom, Document>

fn is_html_document_for_layout(&self) -> bool

fn quirks_mode(self) -> QuirksMode

fn style_shared_lock(self) -> &'dom StyleSharedRwLock

fn shadow_roots(self) -> Vec<LayoutDom<'dom, ShadowRoot>>

fn shadow_roots_styles_changed(self) -> bool

fn flush_shadow_roots_stylesheets(self)

impl<'dom> LayoutElementHelpers<'dom> for LayoutDom<'dom, Element>

fn attrs(self) -> &'dom [LayoutDom<'dom, Attr>]

fn has_class_or_part_for_layout( self, name: &AtomIdent, attr_name: &LocalName, case_sensitivity: CaseSensitivity, ) -> bool

fn get_classes_for_layout(self) -> Option<&'dom [Atom]>

fn get_parts_for_layout(self) -> Option<&'dom [Atom]>

fn synthesize_presentational_hints_for_legacy_attributes<V>(self, hints: &mut V)

where V: Push<ApplicableDeclarationBlock>,

fn get_span(self) -> Option<u32>

fn get_colspan(self) -> Option<u32>

fn get_rowspan(self) -> Option<u32>

fn is_html_element(&self) -> bool

fn id_attribute(self) -> *const Option<Atom>

fn style_attribute(self) -> *const Option<Arc<Locked<PropertyDeclarationBlock>>>

fn local_name(self) -> &'dom LocalName

fn namespace(self) -> &'dom Namespace

fn get_lang_attr_val_for_layout(self) -> Option<&'dom str>

fn get_lang_for_layout(self) -> String

fn get_state_for_layout(self) -> ElementState

fn insert_selector_flags(self, flags: ElementSelectorFlags)

fn get_selector_flags(self) -> ElementSelectorFlags

fn get_shadow_root_for_layout(self) -> Option<LayoutDom<'dom, ShadowRoot>>

The shadow root this element is a host of.

fn get_attr_for_layout( self, namespace: &Namespace, name: &LocalName, ) -> Option<&'dom AttrValue>

fn get_attr_val_for_layout( self, namespace: &Namespace, name: &LocalName, ) -> Option<&'dom str>

fn get_attr_vals_for_layout(self, name: &LocalName) -> Vec<&'dom AttrValue>

impl<'dom> LayoutFileListHelpers<'dom> for LayoutDom<'dom, FileList>

fn len(&self) -> usize

fn file_for_layout(&self, index: u32) -> Option<&File>

impl LayoutHTMLCanvasElementHelpers for LayoutDom<'_, HTMLCanvasElement>

fn data(self) -> HTMLCanvasData

impl LayoutHTMLImageElementHelpers for LayoutDom<'_, HTMLImageElement>

fn image_url(self) -> Option<ServoUrl>

fn image_data(self) -> (Option<Image>, Option<ImageMetadata>)

fn image_density(self) -> Option<f64>

fn get_width(self) -> LengthOrPercentageOrAuto

fn get_height(self) -> LengthOrPercentageOrAuto

impl<'dom> LayoutHTMLInputElementHelpers<'dom> for LayoutDom<'dom, HTMLInputElement>

fn value_for_layout(self) -> Cow<'dom, str>

In the past, we are handling the display of element inside the dom tree traversal. With the introduction of shadow DOM, these implementations will be replaced one by one and these will be obselete,

fn size_for_layout(self) -> u32

Textual input, specifically text entry and domain specific input has a default preferred size.

https://html.spec.whatwg.org/multipage/#the-input-element-as-a-text-entry-widget https://html.spec.whatwg.org/multipage/#the-input-element-as-domain-specific-widgets

fn selection_for_layout(self) -> Option<Range<usize>>

impl LayoutHTMLTextAreaElementHelpers for LayoutDom<'_, HTMLTextAreaElement>

fn value_for_layout(self) -> String

fn selection_for_layout(self) -> Option<Range<usize>>

fn get_cols(self) -> u32

fn get_rows(self) -> u32

impl LayoutHTMLVideoElementHelpers for LayoutDom<'_, HTMLVideoElement>

fn data(self) -> HTMLMediaData

fn get_width(self) -> LengthOrPercentageOrAuto

fn get_height(self) -> LengthOrPercentageOrAuto

impl<'dom> LayoutNodeHelpers<'dom> for LayoutDom<'dom, Node>

fn is_text_input(&self) -> bool

Whether this element should layout as a special case input element.

fn type_id_for_layout(self) -> NodeTypeId

fn is_element_for_layout(&self) -> bool

fn is_text_node_for_layout(&self) -> bool

fn parent_node_ref(self) -> Option<LayoutDom<'dom, Node>>

fn composed_parent_node_ref(self) -> Option<LayoutDom<'dom, Node>>

fn first_child_ref(self) -> Option<LayoutDom<'dom, Node>>

fn last_child_ref(self) -> Option<LayoutDom<'dom, Node>>

fn prev_sibling_ref(self) -> Option<LayoutDom<'dom, Node>>

fn next_sibling_ref(self) -> Option<LayoutDom<'dom, Node>>

fn owner_doc_for_layout(self) -> LayoutDom<'dom, Document>

fn containing_shadow_root_for_layout( self, ) -> Option<LayoutDom<'dom, ShadowRoot>>

fn assigned_slot_for_layout(self) -> Option<LayoutDom<'dom, HTMLSlotElement>>

unsafe fn get_flag(self, flag: NodeFlags) -> bool

unsafe fn set_flag(self, flag: NodeFlags, value: bool)

fn style_data(self) -> Option<&'dom StyleData>

fn layout_data(self) -> Option<&'dom GenericLayoutData>

unsafe fn initialize_style_data(self)

Initialize the style data of this node.

unsafe fn initialize_layout_data(self, new_data: Box<GenericLayoutData>)

Initialize the opaque layout data of this node.

unsafe fn clear_style_and_layout_data(self)

Clear the style and opaque layout data of this node.

fn is_single_line_text_inner_editor(&self) -> bool

Whether this element serve as a container of editable text for a text input that is implemented as an UA widget.

fn is_text_container_of_single_line_input(&self) -> bool

Whether this element serve as a container of any text inside a text input that is implemented as an UA widget.

fn text_content(self) -> Cow<'dom, str>

fn selection(self) -> Option<Range<usize>>

fn image_url(self) -> Option<ServoUrl>

fn image_data(self) -> Option<(Option<Image>, Option<ImageMetadata>)>

fn image_density(self) -> Option<f64>

fn canvas_data(self) -> Option<HTMLCanvasData>

fn media_data(self) -> Option<HTMLMediaData>

fn svg_data(self) -> Option<SVGElementData>

fn iframe_browsing_context_id(self) -> Option<BrowsingContextId>

fn iframe_pipeline_id(self) -> Option<PipelineId>

fn opaque(self) -> OpaqueNode

fn implemented_pseudo_element(&self) -> Option<PseudoElement>

fn is_in_ua_widget(&self) -> bool

impl LayoutSVGSVGElementHelpers for LayoutDom<'_, SVGSVGElement>

fn data(self) -> SVGElementData

impl<'dom> LayoutShadowRootHelpers<'dom> for LayoutDom<'dom, ShadowRoot>

fn get_host_for_layout(self) -> LayoutDom<'dom, Element>

fn get_style_data_for_layout(self) -> &'dom CascadeData

unsafe fn flush_stylesheets<E: TElement>( self, stylist: &mut Stylist, guard: &SharedRwLockReadGuard<'_>, )

impl<T> PartialEq for LayoutDom<'_, T>

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<T> Copy for LayoutDom<'_, T>

impl<T> Eq for LayoutDom<'_, T>