laika-core
API
Generated with
laika-core/laika/laika.ast/Path/Root

Root

laika.ast.Path$.Root$
case object Root extends Path

The root of an absolute path.

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Path
trait VirtualPath
trait Serializable
trait Product
trait Equals
trait GenericPath
class Object
trait Matchable
class Any
Show all
Self type
Root.type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton
type Self = Path

Attributes

Inherited from:
Path

Value members

Concrete methods

def /(path: RelativePath): Path

Combines this path with the specified relative path.

Combines this path with the specified relative path.

Attributes

def isSubPath(other: Path): Boolean

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

def relativeTo(path: Path): RelativePath

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

Inherited methods

def /(name: String): Self

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
def basename: String

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
def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def relative: RelativePath

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

Inherited from:
Path
def withBasename(name: String): Self

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
def withFragment(fragment: String): Self

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
def withSuffix(suffix: String): Self

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
def withoutFragment: Self

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
def withoutSuffix: Self

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

Concrete fields

val depth: Int

The depth of this path from the virtual root.

The depth of this path from the virtual root.

Attributes

val fragment: Option[String]

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

val name: String

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

val parent: Path

The parent of this path. Will return this if this path represents a root node.

The parent of this path. Will return this if this path represents a root node.

Attributes

val suffix: Option[String]

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

override val toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Generated with