File: offset.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (72 lines) | stat: -rw-r--r-- 2,039 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2020 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package quantity

import (
	"errors"
	"fmt"
)

// Offset describes the offset in bytes and is a thin wrapper around Size.
type Offset Size

const (
	// OffsetKiB is the byte size of one kibibyte (2^10 = 1024 bytes)
	OffsetKiB = Offset(1 << 10)
	// OffsetMiB is the offset of one mebibyte (2^20)
	OffsetMiB = Offset(1 << 20)
)

func (o *Offset) String() string {
	return (*Size)(o).String()
}

// IECString formats the offset using multiples from IEC units (i.e. kibibytes,
// mebibytes), that is as multiples of 1024. Printed values are truncated to 2
// decimal points.
func (o *Offset) IECString() string {
	return iecSizeString(int64(*o))
}

func (o *Offset) UnmarshalYAML(unmarshal func(any) error) error {
	var gs string
	if err := unmarshal(&gs); err != nil {
		return errors.New(`cannot unmarshal gadget offset`)
	}

	var err error
	*o, err = ParseOffset(gs)
	if err != nil {
		return fmt.Errorf("cannot parse offset %q: %v", gs, err)
	}
	return err
}

// ParseOffset parses a string expressing offset in a gadget specific format. The
// accepted format is one of: <bytes> | <bytes/2^20>M | <bytes/2^30>G.
func ParseOffset(gs string) (Offset, error) {
	offs, err := parseSizeOrOffset(gs)
	if offs < 0 {
		// XXX: in theory offsets can be negative, but not in gadget
		// YAML
		return 0, errors.New("offset cannot be negative")
	}
	return Offset(offs), err
}