os-lib
API
Generated with
os-lib/os/BasePath

BasePath

os.BasePath
See theBasePath companion object
trait BasePath

A path which is either an absolute Path, a relative RelPath, or a ResourcePath with shared APIs and implementations.

Most of the filesystem-independent path-manipulation logic that lets you splice paths together or navigate in and out of paths lives in this interface

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BasePathImpl
class Path
class ZipRoot
class RelPath
class ResourcePath
class SubPath
trait FilePath
Show all

Members list

Type members

Types

type ThisType <: BasePath

Value members

Abstract methods

def /(chunk: PathChunk): ThisType

Combines this path with the given relative path, returning a path of the same type as this one (e.g. Path returns Path, RelPath returns RelPath

Combines this path with the given relative path, returning a path of the same type as this one (e.g. Path returns Path, RelPath returns RelPath

Attributes

def baseName: String

Gives you the base name of this path, ie without the extension

Gives you the base name of this path, ie without the extension

Attributes

def endsWith(target: RelPath): Boolean

This path ends with the target path, including if it's identical

This path ends with the target path, including if it's identical

Attributes

def ext: String

Gives you the file extension of this path, or the empty string if there is no extension

Gives you the file extension of this path, or the empty string if there is no extension

Attributes

def last: String

The last segment in this path. Very commonly used, e.g. it represents the name of the file/folder in filesystem paths

The last segment in this path. Very commonly used, e.g. it represents the name of the file/folder in filesystem paths

Attributes

def relativeTo(target: ThisType): RelPath

Relativizes this path with the given target path, finding a relative path p such that base/p == this.

Relativizes this path with the given target path, finding a relative path p such that base/p == this.

Note that you can only relativize paths of the same type, e.g. Path & Path or RelPath & RelPath. In the case of RelPath, this can throw a PathError.NoRelativePath if there is no relative path that satisfies the above requirement in the general case.

Attributes

def segments: IterableOnce[String]

The individual path segments of this path.

The individual path segments of this path.

Attributes

def startsWith(target: ThisType): Boolean

This path starts with the target path, including if it's identical

This path starts with the target path, including if it's identical

Attributes

Concrete methods

def subRelativeTo(target: ThisType): SubPath

Relativizes this path with the given target path, finding a sub path p such that base/p == this.

Relativizes this path with the given target path, finding a sub path p such that base/p == this.

Attributes

Generated with