// Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you 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 scalar import ( "bytes" "unicode/utf8" "github.com/apache/arrow/go/v6/arrow" "github.com/apache/arrow/go/v6/arrow/memory" "golang.org/x/xerrors" ) type BinaryScalar interface { Scalar Retain() Release() Data() []byte } type Binary struct { scalar Value *memory.Buffer } func (b *Binary) Retain() { b.Value.Retain() } func (b *Binary) Release() { b.Value.Release() } func (b *Binary) value() interface{} { return b.Value } func (b *Binary) Data() []byte { return b.Value.Bytes() } func (b *Binary) equals(rhs Scalar) bool { return bytes.Equal(b.Value.Bytes(), rhs.(BinaryScalar).Data()) } func (b *Binary) String() string { if !b.Valid { return "null" } return string(b.Value.Bytes()) } func (b *Binary) CastTo(to arrow.DataType) (Scalar, error) { if !b.Valid { return MakeNullScalar(to), nil } switch to.ID() { case arrow.BINARY: return b, nil case arrow.STRING: return NewStringScalarFromBuffer(b.Value), nil case arrow.FIXED_SIZE_BINARY: if b.Value.Len() == to.(*arrow.FixedSizeBinaryType).ByteWidth { return NewFixedSizeBinaryScalar(b.Value, to), nil } } return nil, xerrors.Errorf("cannot cast non-null binary scalar to type %s", to) } func (b *Binary) Validate() (err error) { err = b.scalar.Validate() if err == nil { err = validateOptional(&b.scalar, b.Value, "value") } return } func (b *Binary) ValidateFull() error { return b.Validate() } func NewBinaryScalar(val *memory.Buffer, typ arrow.DataType) *Binary { return &Binary{scalar{typ, true}, val} } type String struct { *Binary } func (s *String) Validate() error { return s.Binary.Validate() } func (s *String) ValidateFull() (err error) { if err = s.Validate(); err != nil { return } if s.Valid && !utf8.ValidString(string(s.Value.Bytes())) { err = xerrors.Errorf("%s scalar contains invalid utf8 data", s.Type) } return } func (s *String) CastTo(to arrow.DataType) (Scalar, error) { if !s.Valid { return MakeNullScalar(to), nil } if to.ID() == arrow.FIXED_SIZE_BINARY { if s.Value.Len() == to.(*arrow.FixedSizeBinaryType).ByteWidth { return NewFixedSizeBinaryScalar(s.Value, to), nil } return nil, xerrors.Errorf("cannot convert string scalar of %s to type %s", string(s.Value.Bytes()), to) } return ParseScalar(to, string(s.Value.Bytes())) } func NewStringScalar(val string) *String { buf := memory.NewBufferBytes([]byte(val)) defer buf.Release() return NewStringScalarFromBuffer(buf) } func NewStringScalarFromBuffer(val *memory.Buffer) *String { val.Retain() return &String{NewBinaryScalar(val, arrow.BinaryTypes.String)} } type FixedSizeBinary struct { *Binary } func (b *FixedSizeBinary) Validate() (err error) { if err = b.Binary.Validate(); err != nil { return } if b.Valid { width := b.Type.(*arrow.FixedSizeBinaryType).ByteWidth if b.Value.Len() != width { err = xerrors.Errorf("%s scalar should have a value of size %d, got %d", b.Type, width, b.Value.Len()) } } return } func (b *FixedSizeBinary) ValidateFull() error { return b.Validate() } func NewFixedSizeBinaryScalar(val *memory.Buffer, typ arrow.DataType) *FixedSizeBinary { val.Retain() return &FixedSizeBinary{NewBinaryScalar(val, typ)} }