writer

Documentation

Overview

Copyright (C) 2019-2020 Vdaas.org Vald team ( kpango, rinx, kmrmt )

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

https://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.

Index

• type MockWriter
  • func (m *MockWriter) Close() error
  • func (m *MockWriter) Open(ctx context.Context, key string) error
  • func (m *MockWriter) Write(p []byte) (n int, err error)
• type Option
  • func WithBucket(bucket string) Option
  • func WithContentType(ct string) Option
  • func WithErrGroup(eg errgroup.Group) Option
  • func WithMaxPartSize(max int64) Option
  • func WithService(s *s3.S3) Option
• type Writer
  • func New(opts ...Option) Writer

Types

type MockWriter

type MockWriter struct {
	OpenFunc  func(ctx context.Context, key string) error
	WriteFunc func(p []byte) (n int, err error)
	CloseFunc func() error
}

MockWriter represents Writer.

func (*MockWriter) Close

func (m *MockWriter) Close() error

Close calls CloseFunc.

func (*MockWriter) Open

func (m *MockWriter) Open(ctx context.Context, key string) error

Open calls OpenFunc.

func (*MockWriter) Write

func (m *MockWriter) Write(p []byte) (n int, err error)

Write calls WriteFunc.

type Option

type Option func(w *writer) error

Option represents the functional option for writer.

func WithBucket

func WithBucket(bucket string) Option

WithBucket returns the option to set bucket for writer.

func WithContentType

func WithContentType(ct string) Option

WithContentType returns the option to set ct for writer.

func WithErrGroup

func WithErrGroup(eg errgroup.Group) Option

WithErrGroup returns the option to set eg for writer.

func WithMaxPartSize

func WithMaxPartSize(max int64) Option

WithMaxPartSize returns the option to set max for writer.

func WithService

func WithService(s *s3.S3) Option

WithService returns the option to set s for writer.

type Writer

type Writer interface {
	Open(ctx context.Context, key string) error
	io.WriteCloser
}

Writer represents an interface to write to s3.

func New

func New(opts ...Option) Writer

New returns Writer implementation.