Giter VIP home page Giter VIP logo

canbeempty's Introduction

canbeempty

canbeempty is a Go package that provides a custom JSON marshaling function, MarshalWithCanBeEmpty, which considers the custom can_be_empty tag. Fields tagged with can_be_empty will be included in the JSON output even if they have zero values.

Features

  • Custom JSON marshaling with can_be_empty tag support.
  • Simple and intuitive to use in any Go project.

Installation

To install the package, run:

go get github.com/yourusername/canbeempty

Usage

Step 1: Import the package

Import the canbeempty package in your Go file:

import "github.com/yourusername/canbeempty"

Step 2: Define your struct with the can_be_empty tag

Define your struct and use the can_be_empty tag for fields that should be included in the JSON output even if they have zero values:

type MyStruct struct {
    Name  string `json:"name,can_be_empty"`
    Age   int    `json:"age"`
    Score int    `json:"score"`
}

Step 3: Use MarshalWithCanBeEmpty to marshal your struct

Use the MarshalWithCanBeEmpty function to marshal your struct to JSON:

package main

import (
    "fmt"
    "log"

    "github.com/yourusername/canbeempty"
)

type MyStruct struct {
    Name  string `json:"name,can_be_empty"`
    Age   int    `json:"age"`
    Score int    `json:"score"`
}

func main() {
    myStruct := MyStruct{
        Name:  "",
        Age:   0,
        Score: 0,
    }

    jsonData, err := canbeempty.MarshalWithCanBeEmpty(myStruct)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Println(string(jsonData))
}

Example Output

Given the struct:

myStruct := MyStruct{
    Name:  "",
    Age:   0,
    Score: 0,
}

The output will be:

{
    "name": "",
    "age": 0,
    "score": 0
}

License

This project is licensed under the MIT License - see the LICENSE file for details.

canbeempty's People

Watchers

Mert avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.