Path

blobstore.url.Path
See thePath companion object
sealed trait Path[+A]

The path segment of a URI. It is parameterized on the type representing the path. This can be a plain String, or a storage provider specific type.

Examples of storage provider types would be software.amazon.awssdk.services.s3.internal.resource.S3ObjectResource for S3, com.google.storage.Blob for GCS, etc.

Attributes

See also
Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AbsolutePath[A]
class RootlessPath[A]

Members list

Value members

Abstract methods

def segments: Chain[String]

Concrete methods

def /(segment: String): Path[String]

Compose with string to form a new Path

Compose with string to form a new Path

The underlying representation must be String in order for the representation and the path to be kept in sync. Use addSegment to modify paths backed by non-String types

Attributes

See also

addSegment

def /(segment: Option[String]): Path[String]
def //(segment: Option[String]): Path[String]
def //(segment: String): Path[String]

Ensure that path always is suffixed with '/'

Ensure that path always is suffixed with '/'

Attributes

def absolute: AbsolutePath[String]
def addSegment[B](segment: String, representation: B): Path[B]

Adds a segment to the path while ensuring that the segments and path representation are kept in sync

Adds a segment to the path while ensuring that the segments and path representation are kept in sync

If you're just working with String paths, see /

Attributes

def as[B](b: B): Path[B]
def dirName(implicit ev: A <:< FsObject): Option[String]
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
def fileName(implicit ev: A <:< FsObject): Option[String]
def fullName(implicit ev: A <:< FsObject): String
override def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def isDir(implicit ev: A <:< FsObject): Boolean
def isEmpty: Boolean
def lastModified(implicit ev: A <:< FsObject): Option[Instant]
def lastSegment: Option[String]
def nioPath: Path
def plain: Plain
def relative: RootlessPath[String]
def size(implicit ev: A <:< FsObject): Option[Long]
def storageClass[SC](implicit storageClassLookup: Aux[A, SC]): Option[SC]
override def 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.

Definition Classes
Any
def up: Plain

Goes one level "up" and looses any information about the underlying path representation

Goes one level "up" and looses any information about the underlying path representation

Attributes

def value: String