27 releases
0.2.1 | Mar 5, 2021 |
---|---|
0.2.0 | Mar 4, 2021 |
0.1.24 | Mar 2, 2021 |
0.1.22 | Feb 20, 2021 |
0.1.1 | Jan 29, 2021 |
#139 in #dom
293 downloads per month
145KB
4.5K
SLoC
mesdoc
A html document node tree operation API.
一个 html 文档树操作接口 API,通过实现该接口可以让节点获得操作 html 文档的各种接口方法。
接口
INodeTrait
方法 | 参数说明 |
---|---|
fn node_type(&self) -> INodeType; |
获取标签类型,类型为枚举 INodeType |
fn typed<'b>(self: Box<Self>) -> IEnumTyped<'b> |
将 Box 的 Node 类型转换为具体的元素类型等 |
fn parent<'b>(&self) -> MaybeElement<'b>; |
获取父元素 |
fn uuid(&self) -> Option<&str>; |
获取标签唯一标识符,用来判断两个元素是否同一元素 |
fn text_content(&self) -> &str; |
获取标签文本内容 |
fn set_text(&mut self, content: &str); |
设置标签文本内容 |
fn set_html(&mut self, content: &str); |
设置元素 html |
fn to_node(self: Box<Self>) -> Box<dyn Any>; |
将节点由 trait object 转换为可判定的真实类型节点 |
fn owner_document(&self) -> MaybeDocResult; |
获取元素的当前 document 文档 |
fn clone_node<'b>(&self) -> BoxDynNode<'b>; |
复制 node 节点 |
IElementTrait : INodeTrait
方法 | 参数说明 |
---|---|
fn tag_name(&self) -> &str; |
获取标签名 |
fn child_nodes<'b>(&self) -> Result<'b>; |
获取所有子元素,包含文本节点、注释节点等 |
fn get_attribute(&self, name: &str) -> Option<IAttrValue>; |
获取标签属性值,值为Option 枚举 IAttrValue |
fn set_attribute(&mut self, name: &str, value: Option<&str>); |
设置标签属性值 |
remove_attribute(&mut self, name: &str); |
删除标签属性值 |
fn inner_html(&self) -> &str; |
获取元素 html |
fn outer_html(&self) -> &str; |
获取元素 html,包含元素自身 |
fn remove_child(&mut self, node: BoxDynElement); |
删除元子元素 |
fn insert_adjacent(&mut self, position: &InsertPosition, node: &BoxDynElement); |
插入节点,其中InsertPosition 为枚举类型,可能值为BeforeStart ,AfterStart ,BeforeEnd , AfterEnd |
fn cloned<'b>(&self) -> BoxDynElement<'b>; |
复制元素,通常为该元素的一个新引用 |
fn into_text<'b>(self:Box<Self>) -> BoxDynText<'b>; |
对于 style,script,title,textarea,pre 类的标签 |
ITextTrait : INodeTrait
方法 | 参数说明 |
---|---|
fn remove(self:Box<Self>); |
移除文本标签 |
fn append_text<'b>(&mut self, content:&str); |
在文本节点结尾添加字符 |
fn prepend_text<'b>(&mut self, content:&str); |
在文本节点开头添加字符 |
IDocumentTrait
方法 | 参数说明 |
---|---|
fn get_element_by_id<'b>(&self, id: &str) -> Option<BoxDynElement<'b>>; |
通过 id 查找标签 |
fn onerror(&self) -> Option<Rc<IErrorHandle>> |
获取错误处理函数,如果需要针对错误进行处理,需要实现该方法。Box<dyn Fn(Box<dyn Error>)> |
fn source_code(&self) -> &'static str; |
获取文档的源代码 |
fn get_root_node<'b>(&self) -> BoxDynNode<'b>; |
获取文档根节点 |
以上即为所有需要实现的接口,实现接口后,将获得类 jQuery API 操作 html 文档的能力,可参照其中的一个实现https://github.com/fefit/visdom,其 README 内有 API 支持的接口方法。
接口说明
-
uuid()
方法用来获取节点的唯一标识符,trait 中默认实现了is
方法来对比两个 node 节点是否相同,如果该对比方法对性能有所影响,可以将is(&BoxDynNode)
方法重写,比如用指针进行比较。 -
index()
接口里默认实现了index()
方法,用来动态计算当前节点在所有兄弟元素中所处的位置顺序,NodeList 里实现的sort
方法依赖于它,如果你的 html 解析库默认已经有元素位置的存储字段,可以重写index()
方法,这样将能提高sort()
方法的性能。
问题 & 建议 & Bugs?
如果您何在使用过程中遇到任问题,或者有好的建议,欢迎提供 Issue.
License
Dependencies
~2.3–4MB
~69K SLoC