couchbase / moss / 235

pending completion

Build # 235

Build Type

push

travis-ci

Committed by

steveyen

Commit Message

<a href="https://github.com/couchbase/moss/commit/<a class=hub.com/couchbase/moss/commit/220b1c29fd14fc7df720801d7615bc24494491b2">220b1c29f<a href="https://github.com/couchbase/moss/commit/220b1c29fd14fc7df720801d7615bc24494491b2">&quot;&gt;MB-23576: Go metalint Make snapshotWrapper public

wrap.go:31:56:warning: exported func NewSnapshotWrapper returns
unexported type *moss.snapshotWrapper, which can be annoying to use

Change-Id: I</a><a class="double-link" href="https://github.com/couchbase/moss/commit/<a class="double-link" href="https://github.com/couchbase/moss/commit/8e4ad009080d8ebd153c74730237318453828ee7">8e4ad0090</a>">8e4ad0090</a><a href="https://github.com/couchbase/moss/commit/220b1c29fd14fc7df720801d7615bc24494491b2">
Reviewed-on: http://review.couchbase.org/76062
Tested-by: Build Bot <build@couchbase.com>
Reviewed-by: Steve Yen <steve.yen@gmail.com>

Run Details

6 of 6 new or added lines in 1 file covered. (100.0%)

2897 of 3507 relevant lines covered (82.61%)

11414.71 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.0

/wrap.go

//  Copyright (c) 2016 Couchbase, Inc.
//  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 moss

import (
        "io"
        "sync"
)

// SnapshotWrapper implements the moss.Snapshot interface.
type SnapshotWrapper struct {
        m        sync.Mutex
        refCount uint64
        ss       Snapshot
        closer   io.Closer // Optional, may be nil.
}

// NewSnapshotWrapper creates a wrapper which provides ref-counting
// around a snapshot.  The snapshot (and an optional io.Closer) will
// be closed when the ref-count reaches zero.
func NewSnapshotWrapper(ss Snapshot, closer io.Closer) *SnapshotWrapper {
        if ss == nil {
                return nil
        }

        return &SnapshotWrapper{refCount: 1, ss: ss, closer: closer}
}

func (w *SnapshotWrapper) addRef() *SnapshotWrapper {
        if w != nil {
                w.m.Lock()
                w.refCount++
                w.m.Unlock()
        }

        return w
}

func (w *SnapshotWrapper) decRef() (err error) {
        w.m.Lock()
        w.refCount--
        if w.refCount <= 0 {
                if w.ss != nil {
                        err = w.ss.Close()
                        w.ss = nil
                }
                if w.closer != nil {
                        w.closer.Close()
                        w.closer = nil
                }
        }
        w.m.Unlock()
        return err
}

// ChildCollectionNames returns an array of child collection name strings.
func (w *SnapshotWrapper) ChildCollectionNames() ([]string, error) {
        w.m.Lock()
        defer w.m.Unlock()
        if w.ss != nil {
                return w.ss.ChildCollectionNames()
        }
        return nil, nil
}

// ChildCollectionSnapshot returns a Snapshot on a given child
// collection by its name.
func (w *SnapshotWrapper) ChildCollectionSnapshot(childCollectionName string) (
        Snapshot, error) {
        w.m.Lock()
        defer w.m.Unlock()
        if w.ss != nil {
                return w.ss.ChildCollectionSnapshot(childCollectionName)
        }
        return nil, nil
}

// Close will decRef the underlying snapshot.
func (w *SnapshotWrapper) Close() (err error) {
        return w.decRef()
}

// Get returns the key from the underlying snapshot.
func (w *SnapshotWrapper) Get(key []byte, readOptions ReadOptions) (
        []byte, error) {
        return w.ss.Get(key, readOptions)
}

// StartIterator initiates a start iterator over the underlying snapshot.
func (w *SnapshotWrapper) StartIterator(
        startKeyInclusive, endKeyExclusive []byte,
        iteratorOptions IteratorOptions,
) (Iterator, error) {
        return w.ss.StartIterator(startKeyInclusive, endKeyExclusive,
                iteratorOptions)
}

1	// Copyright (c) 2016 Couchbase, Inc.
2	// Licensed under the Apache License, Version 2.0 (the "License");
3	// you may not use this file except in compliance with the
4	// License. You may obtain a copy of the License at
5	// http://www.apache.org/licenses/LICENSE-2.0
6	// Unless required by applicable law or agreed to in writing,
7	// software distributed under the License is distributed on an "AS
8	// IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
9	// express or implied. See the License for the specific language
10	// governing permissions and limitations under the License.
11
12	package moss
13
14	import (
15	"io"
16	"sync"
17	)
18
19	// SnapshotWrapper implements the moss.Snapshot interface.
20	type SnapshotWrapper struct {
21	m sync.Mutex
22	refCount uint64
23	ss Snapshot
24	closer io.Closer // Optional, may be nil.
25	}
26
27	// NewSnapshotWrapper creates a wrapper which provides ref-counting
28	// around a snapshot. The snapshot (and an optional io.Closer) will
29	// be closed when the ref-count reaches zero.
30	func NewSnapshotWrapper(ss Snapshot, closer io.Closer) *SnapshotWrapper {	459✔
31	if ss == nil {	553✔
32	return nil	94✔
33	}	94✔
34
35	return &SnapshotWrapper{refCount: 1, ss: ss, closer: closer}	365✔
36	}
37
38	func (w SnapshotWrapper) addRef() SnapshotWrapper {	1,313✔
39	if w != nil {	2,331✔
40	w.m.Lock()	1,018✔
41	w.refCount++	1,018✔
42	w.m.Unlock()	1,018✔
43	}	1,018✔
44
45	return w	1,313✔
46	}
47
48	func (w *SnapshotWrapper) decRef() (err error) {	942✔
49	w.m.Lock()	942✔
50	w.refCount--	942✔
51	if w.refCount <= 0 {	1,071✔
52	if w.ss != nil {	258✔
53	err = w.ss.Close()	129✔
54	w.ss = nil	129✔
55	}	129✔
56	if w.closer != nil {	129✔
57	w.closer.Close()	×
58	w.closer = nil	×
59	}	×
60	}
61	w.m.Unlock()	943✔
62	return err	943✔
63	}
64
65	// ChildCollectionNames returns an array of child collection name strings.
66	func (w *SnapshotWrapper) ChildCollectionNames() ([]string, error) {	×
67	w.m.Lock()	×
68	defer w.m.Unlock()	×
69	if w.ss != nil {	×
70	return w.ss.ChildCollectionNames()	×
71	}	×
72	return nil, nil	×
73	}
74
75	// ChildCollectionSnapshot returns a Snapshot on a given child
76	// collection by its name.
77	func (w *SnapshotWrapper) ChildCollectionSnapshot(childCollectionName string) (
78	Snapshot, error) {	×
79	w.m.Lock()	×
80	defer w.m.Unlock()	×
81	if w.ss != nil {	×
82	return w.ss.ChildCollectionSnapshot(childCollectionName)	×
83	}	×
84	return nil, nil	×
85	}
86
87	// Close will decRef the underlying snapshot.
88	func (w *SnapshotWrapper) Close() (err error) {	599✔
89	return w.decRef()	599✔
90	}	599✔
91
92	// Get returns the key from the underlying snapshot.
93	func (w *SnapshotWrapper) Get(key []byte, readOptions ReadOptions) (
94	[]byte, error) {	4,017✔
95	return w.ss.Get(key, readOptions)	4,017✔
96	}	4,017✔
97
98	// StartIterator initiates a start iterator over the underlying snapshot.
99	func (w *SnapshotWrapper) StartIterator(
100	startKeyInclusive, endKeyExclusive []byte,
101	iteratorOptions IteratorOptions,
102	) (Iterator, error) {	225✔
103	return w.ss.StartIterator(startKeyInclusive, endKeyExclusive,	225✔
104	iteratorOptions)	225✔
105	}	225✔

couchbase / moss / 235

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous