Versions in this module Expand all Collapse all v1 v1.0.1 Oct 13, 2026 v1.0.0 Oct 13, 2026 Changes in this version + var ErrDiskNotFound = errors.New("medialibrary: disk not found") + var ErrInvalidArgument = errors.New("medialibrary: invalid argument") + var ErrMimeNotAllowed = errors.New("medialibrary: mime type not allowed") + var ErrNotFound = errors.New("medialibrary: not found") + var ErrNotImage = errors.New("medialibrary: not an image") + var ErrReplaceFailed = errors.New("medialibrary: failed to replace previous media") + func ConversionPath(m Media, conversion string) string + func Migrate(db *gorm.DB) error + func OriginalPath(m Media) string + func ParseResponsiveWidth(fileName string) (int, bool) + func PrimaryKeyID(model any) (uint64, error) + func ResponsiveConversionKey(conversionName string) string + func ResponsiveImageFileName(m Media, conversionName string, width, height int) string + func ResponsiveImagePath(m Media, fileName string) string + func ResponsiveImagesDir(m Media) string + type AddOption func(*addOptions) + func OnConversionsDisk(name string) AddOption + func OnDisk(name string) AddOption + type CollectionBuilder struct + func (b *CollectionBuilder) AcceptsMimeTypes(mimes ...string) *CollectionBuilder + func (b *CollectionBuilder) ConversionsDisk(name string) *CollectionBuilder + func (b *CollectionBuilder) Disk(name string) *CollectionBuilder + func (b *CollectionBuilder) SingleFile() *CollectionBuilder + func (b *CollectionBuilder) WithResponsiveImages() *CollectionBuilder + type CollectionConfig struct + AcceptsMimeTypes []string + ConversionsDisk string + Disk string + Name string + ResponsiveImages bool + SingleFile bool + type ConversionBuilder struct + func (b *ConversionBuilder) Crop(width, height int) *ConversionBuilder + func (b *ConversionBuilder) Fit(width, height int) *ConversionBuilder + func (b *ConversionBuilder) ForCollection(name string) *ConversionBuilder + func (b *ConversionBuilder) Quality(q int) *ConversionBuilder + func (b *ConversionBuilder) WithResponsiveImages() *ConversionBuilder + type ConversionConfig struct + Collection string + Crop bool + Height int + Name string + Quality int + ResponsiveImages bool + Width int + type Disk interface + Delete func(ctx context.Context, path string) error + Exists func(ctx context.Context, path string) (bool, error) + Name func() string + Open func(ctx context.Context, path string) (io.ReadCloser, error) + Put func(ctx context.Context, path string, r io.Reader) (int64, error) + URL func(path string) string + type FileSource struct + func FromPath(path string) (*FileSource, error) + func FromReader(r io.Reader, fileName, mimeType string) (*FileSource, error) + func (f *FileSource) WithName(name string) *FileSource + type HasMedia interface + MediaModelID func() uint64 + MediaModelType func() string + func ModelFrom(id uint64, modelType string) HasMedia + type Library struct + func New(db *gorm.DB, opts ...Option) *Library + func (l *Library) AddMedia(ctx context.Context, model HasMedia, collectionName string, source *FileSource, ...) (*Media, error) + func (l *Library) ClearMediaCollection(ctx context.Context, model HasMedia, collectionName string) error + func (l *Library) DB() *gorm.DB + func (l *Library) Delete(ctx context.Context, media Media) error + func (l *Library) Find(id uint64) (*Media, error) + func (l *Library) GetFirstMedia(model HasMedia, collectionName string) (*Media, error) + func (l *Library) GetFirstMediaURL(model HasMedia, collectionName string, conversionName ...string) (string, error) + func (l *Library) GetMedia(model HasMedia, collectionName ...string) ([]Media, error) + func (l *Library) GetResponsiveImageURLs(media Media, conversionName ...string) ([]string, error) + func (l *Library) GetSrcset(media Media, conversionName ...string) (string, error) + func (l *Library) GetURL(media Media, conversionName ...string) (string, error) + func (l *Library) Register(modelType string, fn func(*Registrar)) + type LocalDisk struct + func NewLocalDisk(name, root, urlPrefix string) *LocalDisk + func (d *LocalDisk) Delete(_ context.Context, path string) error + func (d *LocalDisk) Exists(_ context.Context, path string) (bool, error) + func (d *LocalDisk) Name() string + func (d *LocalDisk) Open(_ context.Context, path string) (io.ReadCloser, error) + func (d *LocalDisk) Put(_ context.Context, path string, r io.Reader) (int64, error) + func (d *LocalDisk) Root() string + func (d *LocalDisk) URL(path string) string + type Media struct + CollectionName string + ConversionsDisk *string + CreatedAt *time.Time + CustomProperties datatypes.JSON + Disk string + FileName string + GeneratedConversions datatypes.JSON + ID uint64 + Manipulations datatypes.JSON + MimeType *string + ModelID uint64 + ModelType string + Name string + OrderColumn *int + ResponsiveImages datatypes.JSON + Size uint64 + UUID *string + UpdatedAt *time.Time + func (Media) TableName() string + func (m Media) CustomPropertyMap() map[string]any + func (m Media) GeneratedConversionMap() map[string]bool + func (m Media) ResponsiveImagesMap() ResponsiveImagesData + type Option func(*Library) + func WithDefaultDisk(name string) Option + func WithDisk(disk Disk) Option + type Registrar struct + func (r *Registrar) Collection(name string) *CollectionBuilder + func (r *Registrar) Conversion(name string) *ConversionBuilder + type ResponsiveImageSet struct + Base64SVG string + URLs []string + type ResponsiveImagesData map[string]ResponsiveImageSet + type S3API interface + DeleteObject func(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error) + GetObject func(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error) + HeadObject func(ctx context.Context, params *s3.HeadObjectInput, optFns ...func(*s3.Options)) (*s3.HeadObjectOutput, error) + PutObject func(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error) + type S3Disk struct + func NewS3Disk(cfg S3DiskConfig) (*S3Disk, error) + func (d *S3Disk) Delete(ctx context.Context, rel string) error + func (d *S3Disk) Exists(ctx context.Context, rel string) (bool, error) + func (d *S3Disk) Name() string + func (d *S3Disk) Open(ctx context.Context, rel string) (io.ReadCloser, error) + func (d *S3Disk) Put(ctx context.Context, rel string, r io.Reader) (int64, error) + func (d *S3Disk) URL(rel string) string + type S3DiskConfig struct + BaseURL string + Bucket string + Client S3API + Name string + Prefix string