Represents an absolute path inside a virtual tree of documents.
Since this is the most commonly used path abstraction in Laika it received a conveniently short type name. The full, accurate name of this type would be AbsoluteVirtualPath
.
Attributes
- Companion
- object
- Source
- paths.scala
- Graph
-
- Supertypes
-
trait VirtualPathtrait Serializabletrait Producttrait Equalstrait GenericPathclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Members list
Type members
Types
Attributes
- Source
- paths.scala
Value members
Abstract methods
The depth of this path from the virtual root.
Indicates whether this path is a sub-path of (or identical to) the specified other path.
Indicates whether this path is a sub-path of (or identical to) the specified other path.
Attributes
- Source
- paths.scala
The parent of this path.
The parent of this path. Will return this if this path represents a root node.
Attributes
- Source
- paths.scala
Interprets this path relative to some other path.
Interprets this path relative to some other path.
The reference path is interpreted as a document path, as relative paths are most commonly used from the perspective of a document, not a tree node.
Attributes
- Source
- paths.scala
Concrete methods
Interprets this path as a relative path - a shortcut for relativeTo(Root)
.
Interprets this path as a relative path - a shortcut for relativeTo(Root)
.
Attributes
- Source
- paths.scala
Inherited methods
Combines this path with the specified relative path.
Combines this path with the specified relative path.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Creates a new path with the specified name as an immediate child of this path.
Creates a new path with the specified name as an immediate child of this path.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
The base name of this path, without the suffix (if present).
The base name of this path, without the suffix (if present).
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
The fragment part of the path (after a #
in the last segment), or None
if this path does not have a fragment component.
The fragment part of the path (after a #
in the last segment), or None
if this path does not have a fragment component.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
The local name of this path, without the optional fragment part, but including the suffix if present.
The local name of this path, without the optional fragment part, but including the suffix if present.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
The suffix of None
if this path name does not have a file suffix separated by a .
.
The suffix of None
if this path name does not have a file suffix separated by a .
.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Returns a new path that replaces the base name with the specified new name while keeping both, suffix and fragment, in case they are present.
Returns a new path that replaces the base name with the specified new name while keeping both, suffix and fragment, in case they are present.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Returns a new path that either replaces the existing fragment component with the specified one or appends it if this path does not have a component yet.
Returns a new path that either replaces the existing fragment component with the specified one or appends it if this path does not have a component yet.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Returns a new path that either replaces the existing suffix with the specified one or appends it if this path does not have a suffix yet.
Returns a new path that either replaces the existing suffix with the specified one or appends it if this path does not have a suffix yet.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Returns a new path that discards this path's fragment, if present.
Returns a new path that discards this path's fragment, if present.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala
Returns a new path that discards this path's suffix, if present.
Returns a new path that discards this path's suffix, if present.
Attributes
- Inherited from:
- GenericPath
- Source
- paths.scala