BucketRef

Type Members

trait DeleteRequest extends AnyRef

A request to delete the bucket.
trait ListRequest extends AnyRef

A request to list the objects inside this bucket.

Abstract Value Members

abstract def create(failsIfExists: Boolean = false)(implicit ec: ExecutionContext): Future[Unit]

Creates the bucket, if the bucket already exists operation will succeed unless parameter failsIfExists is true.
Creates the bucket, if the bucket already exists operation will succeed unless parameter failsIfExists is true.
failsIfExists
if true, the future will be failed if the bucket already exists.
Note
On some module configuring failsIfExists to true may slow down this operation.
import scala.concurrent.{ ExecutionContext, Future } import com.zengularity.benji.{ BucketRef, ObjectStorage } def setupBucket( store: ObjectStorage, name: String)( implicit ec: ExecutionContext): Future[BucketRef] = { // Make sure a bucket is available (either a new or existing one) val bucket = store.bucket(name) bucket.create(failsIfExists = false).map(_ => bucket) }

abstract def delete: DeleteRequest

Prepares a request to delete the referenced bucket.

import akka.stream.Materializer

import com.zengularity.benji.BucketRef

def foo(myBucket: BucketRef)(implicit m: Materializer) =
  myBucket.delete() // .delete.apply()

def bar(myBucket: BucketRef)(implicit m: Materializer) =
  myBucket.delete.ignoreIfNotExists() // delete.ignoreIfNotExists.apply()

abstract def exists(implicit ec: ExecutionContext): Future[Boolean]

Determines whether or not the bucket exists.
Determines whether or not the bucket exists. false might be returned also in cases where you don't have permission to view a certain bucket.
```
import scala.concurrent.{ ExecutionContext, Future }

import com.zengularity.benji.ObjectStorage

def check(store: ObjectStorage, name: String)(
  implicit ec: ExecutionContext): Future[Boolean] =
  store.bucket(name).exists
```
abstract def name: String

The name of the bucket.
abstract def obj(objectName: String): ObjectRef

Returns a reference to an child object, specified by the given name.
Returns a reference to an child object, specified by the given name.
objectName
the name of child object
```
import scala.concurrent.ExecutionContext
import com.zengularity.benji.BucketRef
def foo(myBucket: BucketRef)(implicit ec: ExecutionContext) =
  myBucket.obj("objInMyBucket").exists
```

abstract def objects: ListRequest

Prepares a request to list the bucket objects.

import akka.stream.Materializer
import com.zengularity.benji.BucketRef

def enumObjects(b: BucketRef)(implicit m: Materializer) = b.objects()

def objectList(b: BucketRef)(implicit m: Materializer) =
  b.objects.collect[List]()

abstract def versioning: Option[BucketVersioning]

Try to get a reference of this bucket that would allow to perform versioning related operations.
Try to get a reference of this bucket that would allow to perform versioning related operations.
returns
Some if the module of the bucket supports versioning related operations, otherwise None.
```
def foo(myBucket: com.zengularity.benji.BucketRef) =
  myBucket.versioning.isDefined
```

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package benji

trait BucketRef extends AnyRef

Type Members

trait DeleteRequest extends AnyRef

trait ListRequest extends AnyRef

Abstract Value Members

abstract def create(failsIfExists: Boolean = false)(implicit ec: ExecutionContext): Future[Unit]

abstract def delete: DeleteRequest

abstract def exists(implicit ec: ExecutionContext): Future[Boolean]

abstract def name: String

abstract def obj(objectName: String): ObjectRef

abstract def objects: ListRequest

abstract def versioning: Option[BucketVersioning]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped