options.go

// Copyright (c) 2017 Cisco and/or its affiliates.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package datasync

import (
	"time"
)

// PutOption defines options for Put operation.
// The available options can be found below.
type PutOption interface {
	// PutOptionMark is used only to mark structures implementing PutOption
	// interface.
	PutOptionMark()
}

// DelOption defines options for Del operation.
// The available options can be found below.
type DelOption interface {
	// DelOptionMark is used to mark structures implementing DelOption
	// interface.
	DelOptionMark()
}

// WithTTLOpt defines TTL for Put operation.
// Once TTL elapses, the associated data are removed from data store.
type WithTTLOpt struct {
	PutOptionMarker
	TTL time.Duration
}

// WithClientLifetimeTTLOpt defines option to Put a value
// for the lifetime of client. Once client is closed TTL is no longer renewed
// and value gets removed.
type WithClientLifetimeTTLOpt struct {
	PutOptionMarker
}

// WithTTL creates a new instance of TTL option.
// Once TTL elapses, the associated data are removed.
// Beware: some implementation might be using TTL with lower precision.
func WithTTL(TTL time.Duration) *WithTTLOpt {
	return &WithTTLOpt{TTL: TTL}
}

// WithClientLifetimeTTL creates a new instance of ClientLifetimeTTL option
func WithClientLifetimeTTL() *WithClientLifetimeTTLOpt {
	return &WithClientLifetimeTTLOpt{}
}

// WithPrefixOpt applies an operation to all items with the specified prefix.
type WithPrefixOpt struct {
	DelOptionMarker
}

// WithPrefix creates a new instance of WithPrefixOpt.
func WithPrefix() *WithPrefixOpt {
	return &WithPrefixOpt{}
}

// PutOptionMarker is meant for anonymous composition in With*Opt structs.
type PutOptionMarker struct{}

// PutOptionMark is used only to mark structures implementing PutOption
// interface.
func (marker *PutOptionMarker) PutOptionMark() {}

// DelOptionMarker is meant for anonymous composition in With*Opt structs.
type DelOptionMarker struct{}

// DelOptionMark is used only to mark structures implementing DelOption
// interface.
func (marker *DelOptionMarker) DelOptionMark() {}