package listcollectionopt

import "go.mongodb.org/mongo-driver/mongo/listcollectionopt"

Index ¶

• type ListCollections
• type ListCollectionsBundle
• func BundleListCollections(opts ...ListCollections) *ListCollectionsBundle
• func (lcb *ListCollectionsBundle) ConvertListCollectionsOption() option.ListCollectionsOptioner
• func (lcb *ListCollectionsBundle) NameOnly(b bool) *ListCollectionsBundle
• func (lcb *ListCollectionsBundle) String() string
• func (lcb *ListCollectionsBundle) Unbundle(deduplicate bool) ([]option.ListCollectionsOptioner, *session.Client, error)
• type ListCollectionsOption
• type ListCollectionsSession
• type ListCollectionsSessionOpt
• func (ListCollectionsSessionOpt) ConvertListCollectionsSession() *session.Client
• type OptNameOnly
• func NameOnly(b bool) OptNameOnly
• func (opt OptNameOnly) ConvertListCollectionsOption() option.ListCollectionsOptioner

Types ¶

type ListCollections ¶

type ListCollections interface {
	// contains filtered or unexported methods
}

ListCollections represents all possible params for the listCollections() function.

type ListCollectionsBundle ¶

type ListCollectionsBundle struct {
	// contains filtered or unexported fields
}

ListCollectionsBundle is a bundle of ListCollections options

func BundleListCollections ¶

func BundleListCollections(opts ...ListCollections) *ListCollectionsBundle

BundleListCollections bundles ListCollections options

func (*ListCollectionsBundle) ConvertListCollectionsOption ¶

func (lcb *ListCollectionsBundle) ConvertListCollectionsOption() option.ListCollectionsOptioner

ConvertListCollectionsOption implements the ListCollections interface

func (*ListCollectionsBundle) NameOnly ¶

func (lcb *ListCollectionsBundle) NameOnly(b bool) *ListCollectionsBundle

NameOnly adds an option to specify whether to return only the collection names.

func (*ListCollectionsBundle) String ¶

func (lcb *ListCollectionsBundle) String() string

String implements the Stringer interface

func (*ListCollectionsBundle) Unbundle ¶

func (lcb *ListCollectionsBundle) Unbundle(deduplicate bool) ([]option.ListCollectionsOptioner, *session.Client, error)

Unbundle transforms a bundle into a slice of options, optionally deduplicating.

type ListCollectionsOption ¶

type ListCollectionsOption interface {
	ListCollections
	ConvertListCollectionsOption() option.ListCollectionsOptioner
}

ListCollectionsOption represents the options for the listCollections() function.

type ListCollectionsSession ¶

type ListCollectionsSession interface {
	ListCollections
	ConvertListCollectionsSession() *session.Client
}

ListCollectionsSession is the session for the ListCollections() function.

type ListCollectionsSessionOpt ¶

type ListCollectionsSessionOpt struct{}

ListCollectionsSessionOpt is a listCollections session option.

func (ListCollectionsSessionOpt) ConvertListCollectionsSession ¶

func (ListCollectionsSessionOpt) ConvertListCollectionsSession() *session.Client

ConvertListCollectionsSession implements the ListCollectionsSession interface.

type OptNameOnly ¶

type OptNameOnly option.OptNameOnly

OptNameOnly specifies whether to return only the collection names.

func NameOnly ¶

func NameOnly(b bool) OptNameOnly

NameOnly specifies whether to return only the collection names.

func (OptNameOnly) ConvertListCollectionsOption ¶

func (opt OptNameOnly) ConvertListCollectionsOption() option.ListCollectionsOptioner

ConvertListCollectionsOption implements the ListCollections interface.

Source Files ¶

listcollectionopt.go