benji-vfs/com.zengularity.benji.vfs/VFSObjectRef

VFSObjectRef

final class VFSObjectRef extends ObjectRef
Companion:
object
trait ObjectRef
class Object
trait Matchable
class Any

Type members

Inherited classlikes

trait DeleteRequest

A request to delete the bucket.

A request to delete the bucket.

Inherited from:
ObjectRef
trait GetRequest

A GET request.

A GET request.

Inherited from:
ObjectRef
trait PutRequest[E, A]

A PUT request: allows you to update the contents of this object.

A PUT request: allows you to update the contents of this object.

Type parameters:
A

the consumer output type

E

the consumer input type

Inherited from:
ObjectRef

Value members

Concrete methods

def copyTo(targetBucketName: String, targetObjectName: String)(implicit ec: ExecutionContext): Future[Unit]
override def equals(that: Any): Boolean
Definition Classes
Any
override def hashCode: Int
Definition Classes
Any
def moveTo(targetBucketName: String, targetObjectName: String, preventOverwrite: Boolean)(implicit ec: ExecutionContext): Future[Unit]
def put[E, A]: PutRequest[E, A]

Inherited methods

def copyTo(target: ObjectRef)(implicit ec: ExecutionContext): Future[Unit]

Copies the referenced object to another one.

Copies the referenced object to another one.

Value parameters:
target

the reference to the target object

import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef
def foo(
 myObject: ObjectRef,
 otherRef: ObjectRef)(implicit ec: ExecutionContext) =
 myObject.copyTo(otherRef)
Inherited from:
ObjectRef
final def moveTo(target: ObjectRef, preventOverwrite: Boolean)(implicit ec: ExecutionContext): Future[Unit]

Moves the referenced object to another one. If fails, the current object is still available.

Moves the referenced object to another one. If fails, the current object is still available.

Value parameters:
preventOverwrite

if true, prevents overwriting an existing target object (default: true)

import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef
def foo(
 myObject: ObjectRef, otherRef: ObjectRef)(
 implicit ec: ExecutionContext) = myObject.moveTo(otherRef)
target

the reference to the target object

Inherited from:
ObjectRef
def put[E](size: Long)(implicit m: Materializer, w: BodyWritable[E]): Sink[E, Future[NotUsed]]
Type parameters:
E

the consumer input type

Value parameters:
size

the total size in bytes to be PUTed

Inherited from:
ObjectRef
def put[E](implicit m: Materializer, w: BodyWritable[E]): Sink[E, Future[NotUsed]]
Type parameters:
E

the consumer input type

Inherited from:
ObjectRef

Concrete fields

lazy override val toString: String